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

docs(readme): use a PR to bump a version #83

Merged
merged 2 commits into from
Oct 17, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Copy link

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

Copy link
Member Author

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.

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}
Copy link

Choose a reason for hiding this comment

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

question: is it something that we can automate? Using GitHub Actions?

Copy link
Member Author

Choose a reason for hiding this comment

The 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.