Add release.md #5
Open
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
takahiro-yamada
requested changes
Mar 18, 2025
| @@ -0,0 +1,35 @@ | |||
| Release procedure | |||
| ================= | |||
There was a problem hiding this comment.
If you don't have strong opinion to maintain this mixed syntax, it seems better to follow the standard defined by markdownlint.
https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md003.md
Comment on lines
+20
to
+24
| ```console | ||
| # Set VERSION and confirm it. It should not have "v" prefix. | ||
| $ VERSION=x.y.z | ||
| $ echo $VERSION | ||
| ``` |
There was a problem hiding this comment.
Similar to the comment above, it seems better to follow the markdownlint, that is replacing console with sh and remove $s.
https://github.com/DavidAnson/markdownlint/blob/v0.37.4/doc/md014.md
Comment on lines
+28
to
+33
| ```console | ||
| $ git checkout main | ||
| $ git tag -a -m "Release v$VERSION" "v$VERSION" | ||
| $ git tag -ln | grep $VERSION | ||
| $ git push origin v$VERSION | ||
| ``` |
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.
Added due to missing release procedures
I would like to know if there are any md's that I should add to the docs file.
Currently it looks good to have at least this much