Skip to content

Commit 947fddd

Browse files
committed
README: Release instructions
1 parent 595439f commit 947fddd

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,14 @@ bundle exec rake # Runs the tests
429429
bundle exec rubocop # Runs the lint (use `--fix` for autocorrect)
430430
```
431431

432+
## Releasing a new gem version
433+
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
437+
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)
439+
432440
## Contributing
433441

434442
1. Fork the project.

0 commit comments

Comments
 (0)