From d8f15b01b858588fde299ebae53be0b82fb04acd Mon Sep 17 00:00:00 2001 From: Dimitris Klouvas Date: Mon, 26 Feb 2024 14:53:00 +0200 Subject: [PATCH] Prepare for 4.0.0.beta1 release (#48) --- CHANGELOG.md | 7 ++++++- Gemfile.lock | 2 +- README.md | 29 ++++++++++++++++++++--------- lib/clerk/version.rb | 2 +- 4 files changed, 28 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 51cec1a..f1cc3a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,9 @@ -## unreleased + +## 4.0.0.beta1 - 2024-02-26 + +- feat: replace interstitial with handshake (internal mechanisms) [https://github.com/clerk/clerk-sdk-ruby/pull/45] +- chore: re-organize and refactor internal code to extract functionality of rack middleware [https://github.com/clerk/clerk-sdk-ruby/pull/45] +- changed: `CLERK_PUBLISHABLE_KEY` or `publishable_key` in `Clerk.configure` is **required** [https://github.com/clerk/clerk-sdk-ruby/pull/46] ## 3.0.0 - 2024-01-09 diff --git a/Gemfile.lock b/Gemfile.lock index 993a517..cb7ead6 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - clerk-sdk-ruby (2.11.1) + clerk-sdk-ruby (4.0.0.beta1) concurrent-ruby (~> 1.1) faraday (>= 1.4.1, < 3.0) jwt (~> 2.5) diff --git a/README.md b/README.md index 44b751d..047962b 100644 --- a/README.md +++ b/README.md @@ -174,18 +174,29 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. -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). +To install this gem onto your local machine, run `bundle exec rake install`. + +## Release + +To release a new version: +- update the version number in `version.rb` +- run `bundle exec rake release` + +If gem publishing is NOT executed automatically: +- run `gem push pkg/clerk-sdk-ruby-{version}.gem` to push the `.gem` file to [rubygems.org](https://rubygems.org) + +The `bundle exec rake release` command: +- creates a git tag with the version found in `version.rb` +- pushes the git tag + +## Yank release + +We should avoid yanking a releasing but if it's necessary execute `gem yank clerk-sdk-ruby -v {version}` ## Contributing -Bug reports and pull requests are welcome on GitHub at -https://github.com/clerkinc/clerk-sdk-ruby. +Bug reports and pull requests are welcome on GitHub at https://github.com/clerkinc/clerk-sdk-ruby. ## License -The gem is available as open source under the terms of the -[MIT License](https://opensource.org/licenses/MIT). +The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/lib/clerk/version.rb b/lib/clerk/version.rb index 0fbcd7a..34e47df 100644 --- a/lib/clerk/version.rb +++ b/lib/clerk/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Clerk - VERSION = "3.0.0" + VERSION = "4.0.0.beta1" end