Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add some detail about release tasks #915

Merged
merged 1 commit into from
Nov 29, 2023
Merged

chore: Add some detail about release tasks #915

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 10 additions & 8 deletions RELEASING.md
View file
Open in desktop
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.