|
1 | 1 | --- |
2 | | -name: Release checklist |
3 | | -about: Steps to take when releasing a new version (only for Oxide release team). |
4 | | -labels: release |
| 2 | +name: Release Checklist |
| 3 | +about: Tracking issue for releasing a new version of the Go SDK. |
| 4 | +title: Release for RXX |
5 | 5 | --- |
6 | 6 |
|
7 | | -## Release checklist |
| 7 | +It's time to release a new version of the Go SDK. Use the checklist below to |
| 8 | +perform the release. |
8 | 9 |
|
9 | | -<!-- |
10 | | - Please follow all of these steps in the order below. |
11 | | - After completing each task put an `x` in the corresponding box, |
12 | | - and paste the link to the relevant PR. |
13 | | ---> |
| 10 | +## Release Checklist |
14 | 11 |
|
15 | | -- [ ] Make sure the [VERSION](https://github.com/oxidecomputer/oxide.go/blob/main/VERSION) file has |
16 | | - the new version you want to release. |
17 | | -- [ ] Make sure the changelog file in the `.changelog/` directory is set to the new version you want |
18 | | - to release. |
19 | | -- [ ] Make sure all examples and docs reference the new version. |
20 | | -- [ ] Make sure you've pulled the latest tag on main, and generate changelog by running |
21 | | - `make changelog`. Add the date of the release to the title, and update associated Oxide API |
| 12 | +- [ ] Ensure the `VERSION` file has the version to be released. |
| 13 | +- [ ] Ensure the `.changelog/<VERSION>.toml` file has the changelog entries for |
| 14 | + the release. |
| 15 | +- [ ] Update the examples and documentation to reference the new version. |
| 16 | +- [ ] Fetch the latest tags from remote and generate the changelog using `make |
| 17 | + changelog`. Update the generated file with the release date and associated |
| 18 | + Oxide API version. |
| 19 | +- [ ] Create the release tag using `make tag`. |
| 20 | +- [ ] Update the GitHub release description with the release content generated |
| 21 | + from `make changelog`. |
| 22 | +- [ ] Create and push a release branch from the commit of the release tag (e.g., |
| 23 | + `X.Y` for release `vX.Y.Z`). |
| 24 | +- [ ] Update the `VERSION` file with the next development version and run `make |
| 25 | + generate` to update generated files. |
| 26 | +- [ ] Create a new `.changelog/<VERSION>.toml` file with the next development |
22 | 27 | version. |
23 | | -- [ ] Release the new version by running `make tag`. |
24 | | -- [ ] Update GitHub release description with release notes generated from `make changelog`. |
25 | | -- [ ] Create a release branch from the commit of the release tag. |
26 | | -- [ ] Bump the version in [VERSION](https://github.com/oxidecomputer/oxide.go/blob/main/VERSION) and |
27 | | - run `make generate` to update the generated files. |
28 | | -- [ ] Create a new file for the next release in |
29 | | - [.changelog/](https://github.com/oxidecomputer/oxide.go/blob/main/.changelog/). |
0 commit comments