From 0210adec984b028d5adcb0517d2e811dcc449eb9 Mon Sep 17 00:00:00 2001 From: Robby Thompson Date: Wed, 13 Nov 2024 10:04:08 -0500 Subject: [PATCH] update docs --- docs/RELEASE.md | 7 +++---- docs/UPGRADING.md | 8 ++++---- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/RELEASE.md b/docs/RELEASE.md index 879124a7..8fc047c8 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -15,13 +15,13 @@ rake install:local # Build and install standard-x.x.x.gem into system gems wi rake release[remote] # Create tag vx.x.x and build and push standard-0.5.2.gem to rubygems.org ``` -Most of these commands are depended on (read: run by) `rake release`, which is +Most of these commands are depended on (read: run by) `./bin/rake release`, which is really the only one we'll need for releasing the gem to [Rubygems.org](https://rubygems.org/gems/standard). ## Release steps -1. Make sure git is up to date and `bundle exec rake` exits cleanly +1. Make sure git is up to date and `./bin/rake` exits cleanly 1. If you upgraded a Rubocop dependency, be sure to lock it down in `standard.gemspec`. To avoid being broken transitively, we stick to exact release dependencies (e.g. "0.91.0" instead of "~> 0.91") @@ -34,9 +34,8 @@ really the only one we'll need for releasing the gem to 1. Run `bundle` so that Bundler writes this version to `Gemfile.lock` 1. Commit `lib/standard/version.rb`, `Gemfile.lock`, and `CHANGELOG.md` together with the message equal to the new version (e.g. "0.42.1") -1. Finally, run `bundle exec rake release`, which will hopefully succeed +1. Finally, run `./bin/rake release`, which will hopefully succeed 1. Provide your multi-factor-auth token when prompted to finish publishing the gem 1. [Tweet](https://twitter.com) about your awesome new release! (Shameless self-promotion is the most important part of open source software) - diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md index 251e8879..0c1e210f 100644 --- a/docs/UPGRADING.md +++ b/docs/UPGRADING.md @@ -11,21 +11,21 @@ The official standard plug-ins that are included in standard are: 1. Update Rubocop plugin in the gemspec file and gem file. 1. Keep standard in the gem file up-to-date. This will bring any testing utilities in standard into the plug-in repository. -1. Run bundle exec rake to run the tests +1. Run `./bin/rake` to run the tests 1. Configure any cops that need to be configured so that the tests pass 1. Update the change log to the best of your ability and title it as unreleased 1. Make your commit for these updates and push to the main branch 1. Update the version in version.rb and update the version in the Changelog replacing the word “Unreleased” 1. Run bundle to write the new version number to the lock file -1. Run bundle exec release to release the gem to RubyGems and create the version git tag. Push the tag to GitHub. +1. Run `./bin/rake release` to release the gem to RubyGems and create the version git tag. Push the tag to GitHub. ## Updating Standard 1. Update Rubocop as well as Standard Performance in the gemspec file and gem file. -1. Run bundle exec rake to run the tests +1. Run `./bin/rake` to run the tests 1. Configure any cops that need to be configured so that the tests pass 1. Update the change log to the best of your ability and title it as unreleased 1. Make your commit for these updates and push to the main branch 1. Update the version in version.rb and update the version in the Changelog replacing the word “Unreleased” 1. Run bundle to write the new version number to the lock file -1. Run bundle exec release to release the gem to RubyGems and create the version git tag. Push the tag to GitHub. +1. Run `./bin/rake` to release the gem to RubyGems and create the version git tag. Push the tag to GitHub.