ruby_git 0.1.3 → 0.3.0

data/RELEASING.md

@@ -1,58 +1,9 @@
 # How to release a new ruby_git gem
 
-Releasing a new version of the `ruby_git` gem requires these steps:
-  * [Prepare the release](#prepare-the-release)
-  * [Create a GitHub release](#create-a-github-release)
-  * [Build and release the gem](#build-and-release-the-gem)
+Run `create-github-release <release-type>` in the root of a clean working tree.
 
-These instructions use an example where the current release version is `1.0.0`
-and the new release version to be created is `1.1.0.pre1`.
+Where `release-type` is `major`, `minor`, or `patch` depending on the nature of the
+changes. Refer to the labels on each PR since the last release to determine which
+semver release type to specify.
 
-## Prepare the release
-
-On a branch (or fork) of ruby_git, create a PR containing changes to (1) bump the
-version number and (2) update the CHANGELOG.md, and (3) tag the release.
-
-  * Bump the version number
-    * Version number is in lib/ruby_git/version.rb
-    * Follow [Semantic Versioning](https://semver.org) guidelines
-    * `bundle exec bump --no-commit patch` # backwards compatible bug fixes
-    * `bundle exec bump --no-commit minor` # backwards compatible new functionality
-    * `bundle exec bump --no-commit major` # incompatible API changes
-    
-  * Update CHANGELOG.md
-    * `bundle exec rake changelog`
-
-  * Stage the changes to be committed
-    * `git add lib/ruby_git/version.rb CHANGELOG.md`
-
-  * Commit, tag, and push changes to the repository
-    * ```git release v`ruby -I lib -r ruby_git -e 'puts RubyGit::VERSION'` ```
-
-  * Create a PR with these changes, have it reviewed and approved, and merged to main.
-
-## Create a GitHub release
-
-On [the ruby_git releases page](https://github.com/jcouball/ruby_git/releases),
-select `Draft a new release`
-
-  * Select the tag corresponding to the version being released `v1.1.0.pre1`
-  * The Target should be `main`
-  * For the release description, copy the relevant section from the CHANGELOG.md
-    * The release description can be edited later.
-  * Select the appropriate value for `This is a pre-release`
-    * Since `v1.1.0.pre1` is a pre-release, check `This is a pre-release`
-
-## Build and release the gem
-
-Clone [jcouball/ruby_git](https://github.com/jcouball/ruby_git) directly (not a
-fork) and ensure your local working copy is on the main branch
-
-  * Verify that you are not on a fork with the command `git remote -v`
-  * Verify that the version number is correct by running `rake -T` and inspecting
-    the output for the `release[remote]` task
-
-Build the git gem and push it to rubygems.org with the command `rake release`
-
-  * Ensure that your `gem sources list` includes `https://rubygems.org` (in my
-    case, I usually have my work’s internal gem repository listed)
+Follow the directions that `create-github-release` after it prepares the release PR.

data/Rakefile

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
-task default: %i[spec bundle:audit rubocop yardstick:audit yardstick:coverage yard build]
+desc 'Run the same tasks that the CI build will run'
+if RUBY_PLATFORM == 'java'
+  task default: %w[spec rubocop bundle:audit build]
+else
+  task default: %w[spec rubocop yard bundle:audit build]
+end
 
 # Bundler Audit
 
@@ -12,10 +17,6 @@ Bundler::Audit::Task.new
 require 'bundler'
 require 'bundler/gem_tasks'
 
-# Bump
-
-require 'bump/tasks'
-
 # RSpec
 
 require 'rspec/core/rake_task'
@@ -30,49 +31,41 @@ CLEAN << 'rspec-report.xml'
 
 require 'rubocop/rake_task'
 
-RuboCop::RakeTask.new do |t|
-  t.options = %w[
-    --format progress
-    --format json --out rubocop-report.json
-  ]
-end
-
-CLEAN << 'rubocop-report.json'
+RuboCop::RakeTask.new
 
 # YARD
 
-require 'yard'
-YARD::Rake::YardocTask.new do |t|
-  t.files = %w[lib/**/*.rb examples/**/*]
-end
+unless RUBY_PLATFORM == 'java'
+  # yard:build
 
-CLEAN << '.yardoc'
-CLEAN << 'doc'
+  require 'yard'
 
-# Yardstick
+  YARD::Rake::YardocTask.new('yard:build') do |t|
+    t.files = %w[lib/**/*.rb examples/**/*]
+    t.options = %w[--no-private]
+    t.stats_options = %w[--list-undoc]
+  end
 
-desc 'Run yardstick to show missing YARD doc elements'
-task :'yardstick:audit' do
-  sh "yardstick 'lib/**/*.rb'"
-end
+  CLEAN << '.yardoc'
+  CLEAN << 'doc'
 
-# Yardstick coverage
+  # yard:audit
 
-require 'yardstick/rake/verify'
+  desc 'Run yardstick to show missing YARD doc elements'
+  task :'yard:audit' do
+    sh "yardstick 'lib/**/*.rb'"
+  end
 
-Yardstick::Rake::Verify.new(:'yardstick:coverage') do |verify|
-  verify.threshold = 100
-end
+  # yard:coverage
+
+  require 'yardstick/rake/verify'
 
-# Changelog
+  Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+    verify.threshold = 100
+  end
 
-require 'github_changelog_generator/task'
+  # yard
 
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.header = '# Change Log'
-  config.user = 'jcouball'
-  config.project = 'ruby_git'
-  config.future_release = "v#{RubyGit::VERSION}"
-  config.release_url = 'https://github.com/jcouball/ruby_git/releases/tag/%s'
-  config.author = true
+  desc 'Run all YARD tasks'
+  task yard: %i[yard:build yard:audit yard:coverage]
 end