Skip to content

Commit

Permalink
Add information about how to release the gem
Browse files Browse the repository at this point in the history
  • Loading branch information
cbliard committed Oct 18, 2024
1 parent 279e5b1 commit 9b39ad6
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Releasing

1. Update the version in `lib/rubocop/open_project/version.rb`
2. Update the changelog in `CHANGELOG.md`
3. Run `bundle install` to update `Gemfile.lock`
4. Run `rake` to check everything is fine and fix any issues
5. Commit your changes (`git commit -am 'Prepare release X.Y.Z'`)
6. Run `bundle exec rake release`

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/opf/rubocop-openproject.
Expand Down

0 comments on commit 9b39ad6

Please sign in to comment.