Skip to content

Commit

Permalink
Release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
anakinj committed Sep 15, 2024
1 parent 71019d7 commit 06b1518
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -694,21 +694,25 @@ jwk_hash = jwk.export
thumbprint_as_the_kid = jwk_hash[:kid]
```

# Development and Tests
# Development and testing

We depend on [Bundler](http://rubygems.org/gems/bundler) for defining gemspec and performing releases to rubygems.org, which can be done with
The tests are written with rspec. [Appraisal](https://github.com/thoughtbot/appraisal) is used to ensure compatibility with 3rd party dependencies providing cryptographic features.

```bash
rake release
bundle install
bundle exec appraisal rake test
```

The tests are written with rspec. [Appraisal](https://github.com/thoughtbot/appraisal) is used to ensure compatibility with 3rd party dependencies providing cryptographic features.
# Releasing

To cut a new release adjust the [version.rb](lib/jwt/version.rb) and [CHANGELOG](CHANGELOG.md) with desired version numbers and dates and commit the changes. Tag the release with the version number using the following command:

```bash
bundle install
bundle exec appraisal rake test
rake release:source_control_push
```

This will tag a new version an trigger a [GitHub action](.github/workflows/push_gem.yml) that eventually will push the gem to rubygems.org.

## How to contribute
See [CONTRIBUTING](CONTRIBUTING.md).

Expand Down

0 comments on commit 06b1518

Please sign in to comment.