From 06b15182e4d12e21dfc17caac0c126fc97975cf7 Mon Sep 17 00:00:00 2001 From: Joakim Antman Date: Sun, 15 Sep 2024 15:17:00 +0300 Subject: [PATCH] Release instructions --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fa8f49d9..0c6ae3fc 100644 --- a/README.md +++ b/README.md @@ -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).