|
| 1 | +# Weave Gitops Release Process |
| 2 | + |
| 3 | +The current release process for weave gitops is fairly straightforward. You need to: |
| 4 | +- Create the actual release |
| 5 | +- Update the `weave-gitops-docs` repository with documentation for the new version |
| 6 | +- Update the `CLI Installation` section of the `README.md` in the `weave-gitops` repository to reference the new version |
| 7 | + |
| 8 | +# Creating the release |
| 9 | +- Go to the `Releases` page for the weave-gitops repository |
| 10 | +- Click on `Draft a New Release` |
| 11 | +- Fill in the `Tag Version` field with the new version (format: `vN.N.N` or `vN.N.N-rc.N` for a pre-release). We have configured go-releaser to implicitly make a version ending in `-rc.N` a pre-release and one without the `rc-N` a full release (but that can be changed after the fact by editing the release if so desired). |
| 12 | +- Fill in the `Release Title` with the same version from the `Tag Version` |
| 13 | +- Click on `Publish Release` |
| 14 | + |
| 15 | +The go-releaser will spin for a bit, generating a changelog and artifacts. |
| 16 | + |
| 17 | +# Updating weave-gitops-docs |
| 18 | +Assuming any changes to user-visible behavior have already been documented for the new release (this should happen when the changes go into `weave-gitops`), you just need to create a new documentation version: |
| 19 | +- Create a branch from main |
| 20 | +- Checkout the new branch |
| 21 | +- Update `docs/installation.md`: |
| 22 | + - Put the new version in the `curl` command |
| 23 | + - Run `wego version` in a downloaded copy of the new release binary and update the `You should see:` section with the output |
| 24 | +- Create a new set of versioned documentation: |
| 25 | + - Run: |
| 26 | + |
| 27 | +```console |
| 28 | +npm run docusaurus docs:version N.N.N |
| 29 | +``` |
| 30 | + |
| 31 | +where the `N.N.N` matches the `N.N.N` from the weave gitops version. |
| 32 | + |
| 33 | +- Add and commit the new files (which will be a new directory containing copies of the files in main at the current point in time). |
| 34 | +- Create a PR and merge when approved |
| 35 | + |
| 36 | +# Updating the README |
| 37 | +- Once the release is available, change the version in the `curl` command shown in the `CLI Installation` section of the `README.md` in the weave-gitops repository |
| 38 | +- Create a PR and merge when approved |
| 39 | + |
| 40 | +That's it! |
0 commit comments