Chore: update release template #1350
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
angela-tran
force-pushed
the
chore/update-release-template
branch
from
dfde12c
to
b4cb8e0
Compare
|
@thekaveman @machikoyasuda Can you read over this and tell me if this list makes sense to you? |
thekaveman
requested changes
Apr 10, 2023
There was a problem hiding this comment.
You're right, this is harder than I expected!
I think the "staging target" thing is needlessly confusing and we can assume by the time we're releasing, dev has already been squared away / secrets configured / QA'd etc.
Also, I think in #1284 we decided that the steps for hotfix are different enough that they warrant docs of their own; so...
Suggestions:
- Reformat into 2 lists: one for
regular, one forhotfix - Make the first step in
regularsomething like "Ensure thedevbranch and secrets are up to date", then bump the version etc. (i.e. we don't need individual steps for updating/refreshing dev secrets) - Remove all the "if applicable" language
This feels overly complicated because we're trying to represent 2 flows in 1 list.
also consolidate steps related to ensuring secrets are up to date
|
Ready for re-review, whenever convenient |
thekaveman
previously approved these changes
Apr 27, 2023
remove item that was meant to explain motivation of subsequent steps Co-authored-by: Kegan Maher <kegan@compiler.la>
|
@thekaveman I settled on removing that extra step 😄 thanks for all your feedback on simplifying this template! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1333
Closes #1284
This PR updates the release issue template to include steps for ensuring secrets are up to date when releasing / deploying the Benefits app.
To simplify the flow of steps, we split the checklist out into two checklists, one for each type of release (Regular and Hotfix).
This PR also updates documentation on "Making a release" to reflect our hotfix checklist.