Skip to content
This repository was archived by the owner on Jun 9, 2022. It is now read-only.

Update README.md - create a new release #45

Merged
merged 2 commits into from
Apr 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,3 @@ changelog: ## Generate changelog
release: changelog ## Release a new tag
git add CHANGELOG.md
git commit -m "chore: update changelog for $(VERSION)"
git tag $(VERSION)
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@
- [How to run it?](#how-to-run-it)
- [Run unit tests](#run-unit-tests)
- [Kind cluster for developing purposes](#kind-cluster-for-developing-purposes)
- [Create a new release](#create-a-new-release)
- [License](#license)

## Prerequisites
Expand Down Expand Up @@ -1053,6 +1054,39 @@ $ kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/ma
$ kubectl delete -A ValidatingWebhookConfiguration ingress-nginx-admission
```

## Create a new release

Below you can find steps to prepare a new release.

1. Create a release branch.

```text
git checkout -b prepare_release_<VERSION> main

# e.g. git checkout -b prepare_release_1.5.6 main
```

2. Update `CHANGELOG.md`.

```
VERSION=1.5.6 make release
```

3. Push the release branch and create a PR

```
git push origin prepare_release_<VERSION>
```

4. After the PR is merged create a tag and push it.

```
git checkout main
git pull
git tag <VERSION> -m "<VERSION>"
git push origin <VERSION>
```

## License

Licensed under the Apache License, Version 2.0.
Expand Down