Skip to content
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

Add release.md #5

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add release.md #5

wants to merge 1 commit into from

Conversation

012xx
Copy link
Contributor

@012xx 012xx commented Mar 17, 2025

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

@012xx 012xx self-assigned this Mar 17, 2025
@takahiro-yamada takahiro-yamada self-requested a review March 18, 2025 01:08
Copy link

@takahiro-yamada takahiro-yamada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you fix typos in README.md too?

@@ -0,0 +1,35 @@
Release procedure
=================

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
```

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants