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.

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

release checklist #870

Merged
merged 9 commits into from
Nov 2, 2020
Merged
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions release-checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Release Checklist

- [ ] [Master branch checks](https://github.com/treeverse/lakeFS/actions?query=branch%3Amaster) are green
- [ ] Create a [new draft release](https://github.com/treeverse/lakeFS/releases/new)
- Bump the version based on [SemVer](https://semver.org/) guidelines.
- Make sure the version is `v` succeeded by the SemVer number. Example: `v1.1.14`.
- If the change includes a migration, it is considered a new feature, and the minor version needs to be bumped.
- [ ] Verify that the [GoReleaser actions](https://github.com/treeverse/lakeFS/actions?query=workflow%3Agoreleaser) triggered by the new draft release completes successfully.
- [ ] Update the release notes (after goreleaser auto-generated list)
- Remove test and documentation related stuff
- Try to sort the list by importance
- Update the description of items if needed so the reader will understand better what this release changes
- Migration should be noted and documented outside the changelog (check the changelog for migrate: prefix):
- How to run the migration if needed
- Whether lakeFS service needs to be down while migration is running (backward compatibility)
- [ ] Uncheck 'This is a pre-release'
- [ ] Update [charts](https://github.com/treeverse/charts) repository (PR, Approve and Commit)
- Bump the `version` patch level (`charts/lakefs/Chart.yaml`)
- Update `appVersion` to the lakeFS version (`charts/lakefs/Chart.yaml`)