-
Notifications
You must be signed in to change notification settings - Fork 9
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
Chore: update documentation and issue template due to tag-based releases #2270
Conversation
Preview url: https://benefits-2270--cal-itp-previews.netlify.app |
Sorry, moving this back to draft again. I just remembered about Issue #1249 and I'm thinking that adding a new section called 'Making a rollback' under Making a release can be used to close #1249 using this PR, if that makes sense. The process is already laid out in the ticket and the docs would look very similar. |
Maybe that can even be another type of release in the dropdown / instructions? E.g. |
Yep, that's a good idea, I'll add it as another type of release 👍 |
c345591
to
3e72043
Compare
Just a note: Since we delete the branch associated with a PR once a PR is merged, I thought that this might create a problem for our hotfix and rollback release processes (since a tag is created on the temporary branches that will get deleted once the hotfix or rollback is merged into |
Interesting... that would seem to mean we don't need to keep |
Yep, it looks like we don't need to keep the It corresponds to |
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.
This is great. Just a few minor suggestions to add some more context, and a couple notes on wording.
One change that I do think we should make for Hotfix and Rollback is that we should be starting from the last known good release tag, not the last known good commit.
Obviously those are the same thing, but we should be primed to think about releases/versions and not so much commits when talking about these types of releases.
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.
Great work on this so far @lalver1
Left some comments / questions
3e72043
to
66ac896
Compare
66ac896
to
e7742f2
Compare
e7742f2
to
828ce67
Compare
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.
Very nice!
Thanks for the helpful reviews and suggestions @angela-tran and @thekaveman ! |
Closes #1249
This PR, which updates the documentation and the
New Release
issue template, is the last followup to PR #2213.