From 8f08045852a612833c4ae7add21593975164e2cb Mon Sep 17 00:00:00 2001 From: Sam Bostock Date: Thu, 10 Mar 2022 18:31:08 -0500 Subject: [PATCH 1/4] Add version release instructions Co-authored-by: Jean-Louis Bostock --- RELEASE.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..651878b --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,21 @@ +# Contribution to Deprecation Toolkit + +## Releasing a new version + +1. Audit PRs and commits merged since the last release, ensuring **all user fancing changes are documented** in `CHANGELOG.md`. +2. Based on the changes, determine whether to increment the major, minor, or patch version, adhering to [Semantic Versioning][semver]. +3. Update the gem version string accordingly in `lib/deprecation_toolkit/version.rb`. +4. Run `bundle install` to update the `Gemfile.lock`. +5. Insert a new heading in `CHANGELOG.md` containing the version identifier and expected release date (e.g. `## 1.2.3 (1999-12-31)`). +6. Commit changes on a new branch and open a PR. +7. **Draft** a [new release][github-new-release] on GitHub, but **do not publish it yet**. +8. Once you have received approval on your PR, merge it into `main`. +9. Deploy using the [ShipIt][shipit] UI, and **verify** the new version is available on [RubyGems][rubygems]. +10. Publish the drafted release, tagging the deployed commit (should be `HEAD` of the `main` branch) with a tag of the form `vMAJOR.MINOR.PATCH`. + +If something goes wrong during the deploy process, address it and tag whatever commit was successfully deployed as that version. + +[semver]: https://semver.org +[github-new-release]: https://github.com/Shopify/deprecation_toolkit/releases/new +[shipit]: https://shipit.shopify.io/shopify/deprecation_toolkit/rubygems +[rubygems]: https://rubygems.org/gems/deprecation_toolkit/versions From cffa573e85827333be69f127b50722aa1d3f51de Mon Sep 17 00:00:00 2001 From: Sam Bostock Date: Thu, 10 Mar 2022 19:50:43 -0500 Subject: [PATCH 2/4] Add missing changelog entries for previous versions Co-authored-by: Jean-Louis Bostock --- CHANGELOG.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6912307..577a497 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,10 +5,21 @@ * [#58](https://github.com/Shopify/deprecation_toolkit/pull/58): Drop support for Ruby < 2.6 & Active Support < 5.2. (@sambostock) * [#58](https://github.com/Shopify/deprecation_toolkit/pull/58): Ensure compatibility with Rails 7. (@sambostock) +## 1.5.1 (2020-04-28) + +* [#46](https://github.com/Shopify/deprecation_toolkit/pull/46): Handle another two part Ruby 2.7 keyword argument deprecation warning. (@casperisfine) + +## 1.5.0 (2020-04-14) + +* [#42](https://github.com/Shopify/deprecation_toolkit/pull/42): Fix Minitest plugin kicking in when it shouldn't. (@Edouard-chin) +* [#45](https://github.com/Shopify/deprecation_toolkit/pull/45): Handle two part Ruby 2.7 keyword argument deprecation warning. (@casperisfine) + ## 1.4.0 (2019-04-29) + * [#37](https://github.com/Shopify/deprecation_toolkit/pull/37): Add Rspec support. (@andrewmarkle) ## 1.3.0 (2019-02-28) + * [#38](https://github.com/Shopify/deprecation_toolkit/pull/38): Add a way to mark test as flaky. (@Edouard-chin) * [#39](https://github.com/Shopify/deprecation_toolkit/pull/39): Introduced a way to help recording massive amount of deprecations. (@Edouard-chin) From 5c75163762e68645d2177327bd04b0c8a50897a2 Mon Sep 17 00:00:00 2001 From: Sam Bostock Date: Thu, 10 Mar 2022 18:37:23 -0500 Subject: [PATCH 3/4] Bump development activesupport version Co-authored-by: Jean-Louis Bostock --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 92c332c..500508f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -7,7 +7,7 @@ PATH GEM remote: https://rubygems.org/ specs: - activesupport (7.0.2.2) + activesupport (7.0.2.3) concurrent-ruby (~> 1.0, >= 1.0.2) i18n (>= 1.6, < 2) minitest (>= 5.1) From 911a4162f70916c27de6ad9fa9f242d6b3c4c3e0 Mon Sep 17 00:00:00 2001 From: Sam Bostock Date: Thu, 10 Mar 2022 18:37:00 -0500 Subject: [PATCH 4/4] Bump version from 1.5.1 to 2.0.0 Co-authored-by: Jean-Louis Bostock --- CHANGELOG.md | 2 ++ Gemfile.lock | 2 +- lib/deprecation_toolkit/version.rb | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 577a497..12c548c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## main (unreleased) +## 2.0.0 (2022-03-16) + * [#58](https://github.com/Shopify/deprecation_toolkit/pull/58): Drop support for Ruby < 2.6 & Active Support < 5.2. (@sambostock) * [#58](https://github.com/Shopify/deprecation_toolkit/pull/58): Ensure compatibility with Rails 7. (@sambostock) diff --git a/Gemfile.lock b/Gemfile.lock index 500508f..d1028fa 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - deprecation_toolkit (1.5.1) + deprecation_toolkit (2.0.0) activesupport (>= 5.2) GEM diff --git a/lib/deprecation_toolkit/version.rb b/lib/deprecation_toolkit/version.rb index b63f59e..9a41e4a 100644 --- a/lib/deprecation_toolkit/version.rb +++ b/lib/deprecation_toolkit/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module DeprecationToolkit - VERSION = "1.5.1" + VERSION = "2.0.0" end