-
Notifications
You must be signed in to change notification settings - Fork 21
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
docs(readme): use a PR to bump a version #83
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -59,12 +59,21 @@ Bump new version number in `CHANGELOG.md` and `README.md`. | |
Commit, tag and create a new release: | ||
|
||
```sh | ||
version="5.0.7" | ||
|
||
git switch --create release/${version} | ||
git add CHANGELOG.md README.md | ||
git commit -m "Bump v5.0.7" | ||
git tag v5.0.7 | ||
git push origin master | ||
git push --tags | ||
gh release create v5.0.7 | ||
git commit -m "Bump v${version}" | ||
git push --set-upstream origin release/${version} | ||
gh pr create --reviewer=EtienneM --title "$(git log -1 --pretty=%B)" | ||
``` | ||
|
||
Once the pull request merged, you can tag the new release. | ||
|
||
```sh | ||
git tag v${version} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. question: is it something that we can automate? Using GitHub Actions? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think so. At least it's not how we do it on other open source projects. |
||
git push origin master v${version} | ||
gh release create v${version} | ||
``` | ||
|
||
The title of the release should be the version number and the text of the release is the same as the changelog. |
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.
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.
question: is it a required command? I don't remember doing this one before using
gh pr create ...
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.
It's indeed not mandatory.
gh pr create
will do it if needed. I wanted it to be explicitly done in this procedure. That's how we documented it in other open source projects.