Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: add short docs for how to release the gem #76

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
- @acroos (Austin C. Roos, austin.roos@wetransfer.com)
- @grdw (Gerard Westerhof, gerard@wetransfer.com)
- @choncou (Unathi Chonco, unathi.chonco@wetransfer.com)
- @epintos (Esteban Pintos, esteban.pintos@wetransfer.com)
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ If you have used the rails generator, you can set the variable to a falsey value

To run the tests for all versions, run this script:

``` shell
```shell
bin/test_all_versions
```

Expand All @@ -77,6 +77,28 @@ Make sure to use the appropriate Ruby version! ActiveRecord <6.0 is not compatib
Bug reports and pull requests are welcome on GitHub at https://github.com/wetransfer/ghost_adapter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](./CODE_OF_CONDUCT.md).
Please add your name to the [CONTRIBUTORS.md](./CONTRIBUTORS.md)

## Releasing

### Updating version

Before releasing, make sure the version is updated appropriately. This can be done with:

```shell
bundle exec bump [major|minor|patch]
```

You should (at least roughly) follow [semver rules](https://semver.org/) for version updates.

### Publishing

Upon each version update, the new gem should be published to rubygems.org. This can be done with:

```shell
bundle exec rake release
```

This will ask you to authenticate to rubygems.org. If you have need credentials, please reach out to one of the [contributors](./CONTRIBUTORS.md)

## License

The gem is available as open source under the terms of the [Hippocratic License](https://firstdonoharm.dev/version/2/1/license.html).
Expand Down