Skip to content

Commit

Permalink
chore: Add some detail about release tasks (#915)
Browse files Browse the repository at this point in the history
This just adds some text to the RELEASING file so we don't forget these
tasks.
  • Loading branch information
kentquirk authored Nov 29, 2023
1 parent 0a5075c commit 6437821
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Release Process

1. Add release entry to [changelog](./CHANGELOG.md)
2. Add a summary of release changes to [release notes](./RELEASE_NOTES.md)
3. Open a PR with the above, and merge that into main
4. Create new tag on merged commit with the new version (e.g. `v1.4.1`)
5. Push the tag upstream (this will kick off the release pipeline in CI)
6. Copy change log entry for newest version into draft GitHub release created as part of CI publish steps
7. Update the `appVersion` and any relevant chart changes in [helm-charts](https://github.com/honeycombio/helm-charts/tree/main/charts/refinery)
8. If either `refinery_config.md` or `refinery_rules.md` were modified in this release, you must also copy these files to docs and do a docs PR.
1. Check that licenses are current with `make verify-licenses`
2. Regenerate documentation with `make all` from within the `tools/convert` folder
3. Add release entry to [changelog](./CHANGELOG.md)
4. Add a summary of release changes to [release notes](./RELEASE_NOTES.md)
5. Open a PR with the above, and merge that into main
6. Create new tag on merged commit with the new version (e.g. `v1.4.1`)
7. Push the tag upstream (this will kick off the release pipeline in CI)
8. Copy change log entry for newest version into draft GitHub release created as part of CI publish steps
9. Update the `appVersion` and any relevant chart changes in [helm-charts](https://github.com/honeycombio/helm-charts/tree/main/charts/refinery)
10. If either `refinery_config.md` or `refinery_rules.md` were modified in this release, you must also copy these files to docs and do a docs PR.

0 comments on commit 6437821

Please sign in to comment.