Create RELEASE.md for release docs #664
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
emcfarlane
force-pushed
the
release.md
branch
from
1c8de5f to
0596e9b
Compare
Adds a new markdown file RELEASE.md to document the release process.
emcfarlane
force-pushed
the
release.md
branch
from
0596e9b to
8f52513
Compare
nicksnyder
reviewed
Dec 27, 2023
There was a problem hiding this comment.
I am surprised at how much the formatting and content of this PR deviates from the Notion doc that we had. I think the list formatting of the notion doc made it more clear that this was a single list of instructions that need to be followed end to end. Can you start with the content of the Notion doc as a baseline and enhance it from there?
|
The other example that we referenced was https://github.com/yarpc/yarpc-go/blob/dev/RELEASE.md, which is also a flat list of instructions, with nice small diffs as examples. |
|
@nicksnyder thanks for reviewing. Have defaulted close to the notion doc with small changes and additions for the example diffs. |
nicksnyder
reviewed
Dec 28, 2023
bufdev
reviewed
Dec 28, 2023
nicksnyder
reviewed
Dec 28, 2023
emcfarlane
commented
Jan 3, 2024
Co-authored-by: Nick Snyder <[email protected]>
Co-authored-by: Nick Snyder <[email protected]>
jhump
reviewed
Jan 5, 2024
nicksnyder
reviewed
Jan 10, 2024
Co-authored-by: Nick Snyder <[email protected]>
jhump
approved these changes
Jan 10, 2024
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.
Adds a new markdown file RELEASE.md to document the release process. Includes the required updates to source code files and a walk through for drafting and publishing a release.