mirrors/external-secrets
1
0
Fork 0
mirror of https://github.com/external-secrets/external-secrets.git synced 2024-12-14 11:57:59 +00:00
Code Activity

chore: move release docs to eso docs

Browse source 
Signed-off-by: Moritz Johner <beller.moritz@googlemail.com>
This commit is contained in:
Moritz Johner 2022-02-21 21:50:14 +01:00
parent f3956acdbe
commit d06c47b38b
3 changed files with 53 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
RELEASE.md
View file

@ -1,19 +0,0 @@
# Release Process
ESO and the ESO Helm Chart have two distinct lifecycles and can be released independently. Helm Chart releases are named `external-secrets-x.y.z`.
The external-secrets project is released on a as-needed basis. Feel free to open a issue to request a release.
## Release ESO
1. Run `Create Release` Action to create a new release, pass in the desired version number to release.
2. GitHub Release, Changelog will be created by the `release.yml` workflow which also promotes the container image.
3. update Helm Chart, see below
4. update OLM bundle, see [helm-operator docs](https://github.com/external-secrets/external-secrets-helm-operator/blob/main/docs/release.md#operatorhubio)
5. Announce the new release in the `#external-secrets` Kubernetes Slack
## Release Helm Chart
1. Update `version` and/or `appVersion` in `Chart.yaml`
2. push and merge PR
3. CI picks up the new chart version and creates a new GitHub Release for it

52
docs/contributing-release.md Normal file
View file

@ -0,0 +1,52 @@
ESO and the ESO Helm Chart have two distinct lifecycles and can be released independently. Helm Chart releases are named `external-secrets-x.y.z`.
The external-secrets project is released on a as-needed basis. Feel free to open a issue to request a release.
## Release ESO
1. Run `Create Release` Action to create a new release, pass in the desired version number to release.
2. GitHub Release, Changelog will be created by the `release.yml` workflow which also promotes the container image.
3. update Helm Chart, see below
4. update OLM bundle, see [helm-operator docs](https://github.com/external-secrets/external-secrets-helm-operator/blob/main/docs/release.md#operatorhubio)
5. Announce the new release in the `#external-secrets` Kubernetes Slack
## Release Helm Chart
1. Update `version` and/or `appVersion` in `Chart.yaml`
2. push and merge PR
3. CI picks up the new chart version and creates a new GitHub Release for it
## Release OLM Bundle
In order to make the latest release available to [OperatorHub.io](https://operatorhub.io/) we need to create a bundle and open a PR in the [community-operators](https://github.com/k8s-operatorhub/community-operators/) repository.
To create a bundle first increment the `VERSION` in the Makefile as described above. Then run the following commands in the root of the repository:
```bash
# clone repo
git clone https://github.com/external-secrets/external-secrets-helm-operator
cd external-secrets-helm-operator
# bump version
export VERSION=x.y.z
sed -i "s/^VERSION ?= .*/VERSION ?= ${VERSION}/" Makefile
# prep release
make prepare-stable-release
```
Check the generated files in the `bundle/` directory. If they look good add & commit them, open a PR against this repository. You can always use the [OperatorHub.io/preview](https://operatorhub.io/preview) page to preview the generated CSV.
```bash
git status
git add .
git commit -s -m "chore: bump version xyz"
git push
```
Once the PR is merged we need create a pull request against both community-operators repositories. There's a make target that does the heavy lifting for you:
```bash
make bundle-operatorhub
```
This command will add/commit/push and open pull requests in the respective repositories.

1
hack/api-docs/mkdocs.yml
View file

@ -72,5 +72,6 @@ nav:
- Contributing:
- Developer guide: contributing-devguide.md
- Contributing Process: contributing-process.md
- Release Process: contributing-release.md
- Code of Conduct: contributing-coc.md
- Deprecation Policy: deprecation-policy.md