Skip to content

Commit a6ba074

Browse files
authored
Merge pull request #554 from rwaffen/update_gem_rls_docs
docs: update releasing_gem.md with additional steps for version release process
2 parents f085f9a + a0fbc55 commit a6ba074

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

_docs/releasing_gem.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ This can be done from a fork.
2020
Now you can install the changelog generator:
2121

2222
```bash
23+
export RELEASE_VERSION="X.Y.Z"
24+
git switch master
25+
git pull --rebase
26+
git switch -c release-v$RELEASE_VERSION
27+
2328
bundle config set --local path '.vendor/'
2429
bundle config set --local with 'release'
2530
bundle install
@@ -35,6 +40,9 @@ We can generate the changelog (in most cases, this requires a [GitHub access tok
3540

3641
```bash
3742
CHANGELOG_GITHUB_TOKEN='mytoken' bundle exec rake changelog
43+
44+
git commit --all --message "Release v${RELEASE_VERSION}"
45+
git push --set-upstream origin HEAD
3846
```
3947

4048
The changelog generator checks for certain labels on closed issues and PRs since the last release and groups them together.
@@ -53,6 +61,7 @@ Or add voxpupuli as a additional remote to your fork.
5361
with the main repo
5462

5563
```bash
64+
export RELEASE_VERSION="X.Y.Z"
5665
git switch master; git pull origin master
5766
```
5867

@@ -68,20 +77,26 @@ git pull --rebase voxpupuli master
6877
Check with `git tag -l` if the git tags are prefixed with a v or not.
6978
This varies by project (we often adopt gems from other people and don't want to change the versioning scheme in a project).
7079

71-
Create a new git tag with the new version: `git tag -s $version`
80+
Create a new git tag with the new version:
81+
82+
```bash
83+
git tag -s -a -m "${RELEASE_VERSION}" $RELEASE_VERSION
84+
# or
85+
git tag -s -a -m "v${RELEASE_VERSION}" v$RELEASE_VERSION
86+
```
7287

7388
Push the git tag:
7489

7590
with main repo:
7691

7792
```bash
78-
git push origin $version
93+
git push origin --tags
7994
```
8095

8196
with a fork:
8297

8398
```bash
84-
git push voxpupuli $version
99+
git push voxpupuli --tags
85100
```
86101

87102
Then a GitHub action will start to build the gem and publish it to GitHub Packages and RubyGems.org

0 commit comments

Comments
 (0)