Skip to content

Commit 47c1a64

Browse files
authored
Merge pull request #484 from zendesk/repl-doc
README: Doc REPL project
2 parents 8245a9a + 947fddd commit 47c1a64

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ The Yard generated documentation is available in at [RubyDoc](https://www.rubydo
1616

1717
Please report any bug in the [Github issues page](https://github.com/zendesk/zendesk_api_client_rb/issues).
1818

19+
You might want to try out this gem in a REPL for exploring your options, if so, check out [this project](https://github.com/zendesk/zendesk_api_client_rb_repl).
20+
1921
## Product Support
2022

2123
This Ruby gem supports the REST API's for Zendesk Support, Zendesk Guide,
@@ -427,6 +429,14 @@ bundle exec rake # Runs the tests
427429
bundle exec rubocop # Runs the lint (use `--fix` for autocorrect)
428430
```
429431

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+
430440
## Contributing
431441

432442
1. Fork the project.

0 commit comments

Comments
 (0)