Skip to content

Commit 8323f78

Browse files
authored
Update development instructions again + update Gemfile.locks (#7)
Update development instructions (again) so that we build the gem as part of the first step so that `Gemfile.lock`s are updated with the new version and can be checked in as part of the version release. Also update a few `Gemfile.lock` updates that were left out of the 0.2.0 release due to this omission.
1 parent 668fc43 commit 8323f78

File tree

3 files changed

+27
-22
lines changed

3 files changed

+27
-22
lines changed

docs/development.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,27 +44,32 @@ $ open coverage/index.html
4444

4545
## Publish gems
4646

47-
```shell
48-
git checkout master && git pull --rebase
49-
export VERSION=v0.0.x
47+
1. Choose a version, run scripts to update the versions in each gemspec file, and build each gem which will update its `Gemfile.lock` with the new version:
5048

51-
ruby scripts/update_gemspec_version.rb riverqueue.gemspec
52-
ruby scripts/update_gemspec_version.rb drivers/riverqueue-activerecord/riverqueue-activerecord.gemspec
53-
ruby scripts/update_gemspec_version.rb drivers/riverqueue-sequel/riverqueue-sequel.gemspec
54-
```
49+
```shell
50+
git checkout master && git pull --rebase
51+
export VERSION=v0.0.x
5552

56-
Update `CHANGELOG.md` to include the new version and open a pull request with those changes and the ones to the gemspecs above.
53+
ruby scripts/update_gemspec_version.rb riverqueue.gemspec
54+
ruby scripts/update_gemspec_version.rb drivers/riverqueue-activerecord/riverqueue-activerecord.gemspec
55+
ruby scripts/update_gemspec_version.rb drivers/riverqueue-sequel/riverqueue-sequel.gemspec
5756

58-
```shell
59-
gem build riverqueue.gemspec
60-
gem push riverqueue-${"${VERSION}"/v/}.gem
57+
gem build riverqueue.gemspec
58+
pushd drivers/riverqueue-activerecord && gem build riverqueue-activerecord.gemspec && popd
59+
pushd drivers/riverqueue-sequel && gem build riverqueue-sequel.gemspec && popd
60+
```
6161

62-
pushd drivers/riverqueue-activerecord && gem build riverqueue-activerecord.gemspec && popd
63-
pushd drivers/riverqueue-activerecord && gem push riverqueue-activerecord-${"${VERSION}"/v/}.gem && popd
62+
2. Update `CHANGELOG.md` to include the new version and open a pull request with those changes and the ones to the gemspecs and `Gemfile.lock`s above.
6463

65-
pushd drivers/riverqueue-sequel && gem build riverqueue-sequel.gemspec && popd
66-
pushd drivers/riverqueue-sequel && gem push riverqueue-sequel-${"${VERSION}"/v/}.gem && popd
64+
3. Build and push each gem, then tag the release and push that:
6765

68-
git tag $VERSION
69-
git push --tags
70-
```
66+
```shell
67+
gem push riverqueue-${"${VERSION}"/v/}.gem
68+
pushd drivers/riverqueue-activerecord && gem push riverqueue-activerecord-${"${VERSION}"/v/}.gem && popd
69+
pushd drivers/riverqueue-sequel && gem push riverqueue-sequel-${"${VERSION}"/v/}.gem && popd
70+
71+
git tag $VERSION
72+
git push --tags
73+
```
74+
75+
4. Cut a new GitHub release by visiting [new release](https://github.com/riverqueue/river/releases/new), selecting the new tag, and copying in the version's `CHANGELOG.md` content as the release body.

drivers/riverqueue-activerecord/Gemfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
PATH
22
remote: ../..
33
specs:
4-
riverqueue (0.1.0)
4+
riverqueue (0.2.0)
55

66
PATH
77
remote: .
88
specs:
9-
riverqueue-activerecord (0.1.0)
9+
riverqueue-activerecord (0.2.0)
1010
activerecord (> 0, < 1000)
1111
activesupport (> 0, < 1000)
1212
pg (> 0, < 1000)

drivers/riverqueue-sequel/Gemfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
PATH
22
remote: ../..
33
specs:
4-
riverqueue (0.1.0)
4+
riverqueue (0.2.0)
55

66
PATH
77
remote: .
88
specs:
9-
riverqueue-sequel (0.1.0)
9+
riverqueue-sequel (0.2.0)
1010
pg (> 0, < 1000)
1111
sequel (> 0, < 1000)
1212

0 commit comments

Comments
 (0)