-
Notifications
You must be signed in to change notification settings - Fork 1
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
Update release process #252
The head ref may contain hidden characters: "\u03A9-41-change-release-process"
Conversation
README.md
Outdated
- Development have the `-dev.N` suffix | ||
- They are used to test new code before an official release is made | ||
- Development versions have the `-dev.N` suffix | ||
- They are used to test new code in QA |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want a new dev release for each feature that goes to QA?
It might make sense once the pace of development slows down somewhat, but at the moment I expect it'll be more of a barrier than a help.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I guess we don't need it, we can rely on just the SHA hashes. Should we get rid of dev releases completely then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dev releases may still be useful, especially if we have some experimental features that we want to deploy somewhere less volatile than a shared QA environment. I think we can leave them in, but remove the item about using them for QA deployments.
Somewhat unrelated: Do we want a version check in version-tagged image builds to make sure the pyproject.toml
version matches the tag?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah we can add that, good idea. You can move a tag to a different commit right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, looks good to me
Purpose
The current release procedure is complex and difficult to understand. It also doesn't match our current development speed, and users often want features much earlier than releases.
Approach
This PR puts together a proposal for a simpler release process, that hopefully better matches the development and usage of contentrepo
It also adds documentation on how to actually create a release.