Skip to content

Commit 392a66a

Browse files
committed
Publish gem
1 parent 7017cca commit 392a66a

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

.github/workflows/publish_gem.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Publish Gem
2+
3+
on:
4+
push:
5+
tags: v*
6+
7+
jobs:
8+
call-workflow:
9+
uses: zendesk/gw/.github/workflows/ruby-gem-publication.yml@main
10+
secrets:
11+
RUBY_GEMS_API_KEY: ${{ secrets.RUBY_GEMS_API_KEY }}
12+
RUBY_GEMS_TOTP_DEVICE: ${{ secrets.RUBY_GEMS_TOTP_DEVICE }}

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -431,11 +431,11 @@ bundle exec rubocop # Runs the lint (use `--fix` for autocorrect)
431431

432432
## Releasing a new gem version
433433

434-
1. Execute `bundle exec rake bump:minor`, which bumps the version in my local machine in a specific commit
435-
2. Change the CHANGELOG and amend that previous commit, so the bump commit and the CHANGELOG changes are in the same commit (example)
436-
3. Push to Github
434+
1. Execute `bundle exec rake bump:patch --tag`, or minor or major according to [SemVer](https://semver.org), this bumps the version in your local machine in the latest commit
435+
2. Update the CHANGELOG amending the previous commit, so the bump and the CHANGELOG changes are in the same commit
436+
3. Push to GitHub `git push && git push origin vX.X.X`
437437
4. Post a message in Slack `#rest-api`, so advocacy are aware that we are going to release a new gem, just in case any customer complains about something related to the gem
438-
5. After a couple of hours, run `bundle exec rake release`, which automatically pushes the tag to GitHub and releases a new version to Rubygems (it does the gem push for you)
438+
5. Raise a PR, get it approved and merge
439439

440440
## Contributing
441441

@@ -448,8 +448,10 @@ bundle exec rubocop # Runs the lint (use `--fix` for autocorrect)
448448
we can ignore when we pull.)
449449
5. Submit a pull request.
450450

451+
**Note:** Live specs will likely fail for external contributors. The Zendesk devs can help with that. If you have permissions and the live specs unexpectedly fail, that might be a data error, see the REPL for that.
452+
451453
## Copyright and license
452454

453-
Copyright 2015-2022 Zendesk
455+
Copyright 2015-2023 Zendesk
454456

455457
See [LICENSE](./LICENSE).

0 commit comments

Comments
 (0)