🎨 Updated gem template w/ kettle-dev v1.1.1

Author: pboling

.gitlab-ci.yml

@@ -12,28 +12,63 @@
 #include:
 #  - template: Security/SAST.gitlab-ci.yml
 
+default:
+  image: ruby
+
 variables:
+  BUNDLE_INSTALL_FLAGS: "--quiet --jobs=$(nproc) --retry=3"
+  BUNDLE_FROZEN: "false" # No lockfile!
+  BUNDLE_GEMFILE: Appraisal.root.gemfile
   K_SOUP_COV_DEBUG: true
   K_SOUP_COV_DO: true
   K_SOUP_COV_HARD: true
   K_SOUP_COV_MIN_BRANCH: 100
   K_SOUP_COV_MIN_LINE: 100
   K_SOUP_COV_VERBOSE: true
-  K_SOUP_COV_FORMATTERS: "html,rcov,lcov,json,tty"
+  K_SOUP_COV_FORMATTERS: "tty"
   K_SOUP_COV_MULTI_FORMATTERS: true
   K_SOUP_COV_COMMAND_NAME: "RSpec Coverage"
 
-default:
-  image: ruby:3.4.3
+workflow:
+  rules:
+    # For merge requests, create a pipeline.
+    - if: '$CI_MERGE_REQUEST_IID'
+    # For the ` main ` branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    # For tags, create a pipeline.
+    - if: '$CI_COMMIT_TAG'
 
-  before_script:
-    - gem update --silent --system
+.current_ruby_template: &current_ruby_template
+  image: ruby:${RUBY_VERSION}
+  stage: test
+  script:
+    # || true so we don't fail here, because it'll probably work even if the gem update fails
+    - gem update --system > /dev/null 2>&1 || true
     - mkdir -p vendor/bundle
     - bundle config set path 'vendor/bundle'
     - chmod +t -R vendor/bundle
     - chmod o-w -R vendor/bundle
-    - bundle install --jobs 4 --retry 3
+    # Setup appraisal2
+    - bundle install
+    # Bundle a specific appraisal
+    - bundle exec appraisal unlocked_deps bundle install
+    # Light smoke test
+    - bundle exec appraisal unlocked_deps bin/rake --tasks
+    # Run tests, skipping those that won't work in CI
+    - >
+      bundle exec appraisal unlocked_deps \
+        bin/rspec spec \
+          --tag \~ci_skip \
+          --format progress \
+          --format RspecJunitFormatter
 
-run_tests:
-  script:
-    - bundle exec rake
+  cache:
+    key: ${CI_JOB_IMAGE}
+    paths:
+      - vendor/ruby
+
+current-ruby:
+  <<: *current_ruby_template
+  parallel:
+    matrix:
+      - RUBY_VERSION: ["3.2", "3.3", "3.4"]

CHANGELOG.md

@@ -84,7 +84,7 @@ Please file a bug if you notice a violation of semantic versioning.
 - More documentation, and yard task for documentation (@pboling)
 - Documentation of Ruby version and SemVer support (@pboling)
 ### Fixed
-- [#3](https://gitlab.com/oauth-xx/version_gem/-/issues/3) - Allow packaging without signing (@pboling)
+- [#3](https://gitlab.com/ruby-oauth/version_gem/-/issues/3) - Allow packaging without signing (@pboling)
   - to support secure linux distros which have alternate means of signing packages within their package managers
 - Code coverage tracking (@pboling)
 - Documentation of usage in gemspec via `Kernel.load` (@pboling)
@@ -163,28 +163,28 @@ Please file a bug if you notice a violation of semantic versioning.
 ### Added
 - Initial release, with basic version parsing API (@pboling)
 
-[Unreleased]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.8...main
-[1.1.8]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.7...v1.1.8
-[1.1.8t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.1.8
-[1.1.7]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.6...v1.1.7
-[1.1.7t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.1.7
-[1.1.6]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.5...v1.1.6
-[1.1.6t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.1.6
-[1.1.5]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.4...v1.1.5
-[1.1.5t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.1.5
-[1.1.4]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.3...v1.1.4
-[1.1.4t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.1.4
-[1.1.3]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.2...v1.1.3
-[1.1.3t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.1.3
-[1.1.2]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.1...v1.1.2
-[1.1.2t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.1.2
-[1.1.1]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.0...v1.1.1
-[1.1.1t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.1.1
-[1.1.0]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.2...v1.1.0
-[1.1.0t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.1.0
-[1.0.2]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.1...v1.0.2
-[1.0.2t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.0.2
-[1.0.1]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.0...v1.0.1
-[1.0.1t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.0.1
-[1.0.0]: https://gitlab.com/oauth-xx/version_gem/-/compare/a3055964517c159bf214712940982034b75264be...v1.0.0
-[1.0.0t]: https://gitlab.com/oauth-xx/version_gem/-/tags/v1.0.0
+[Unreleased]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.8...main
+[1.1.8]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.7...v1.1.8
+[1.1.8t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.1.8
+[1.1.7]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.6...v1.1.7
+[1.1.7t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.1.7
+[1.1.6]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.5...v1.1.6
+[1.1.6t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.1.6
+[1.1.5]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.4...v1.1.5
+[1.1.5t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.1.5
+[1.1.4]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.3...v1.1.4
+[1.1.4t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.1.4
+[1.1.3]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.2...v1.1.3
+[1.1.3t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.1.3
+[1.1.2]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.1...v1.1.2
+[1.1.2t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.1.2
+[1.1.1]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.0...v1.1.1
+[1.1.1t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.1.1
+[1.1.0]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.0.2...v1.1.0
+[1.1.0t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.1.0
+[1.0.2]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.0.1...v1.0.2
+[1.0.2t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.0.2
+[1.0.1]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.0.0...v1.0.1
+[1.0.1t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.0.1
+[1.0.0]: https://gitlab.com/ruby-oauth/version_gem/-/compare/a3055964517c159bf214712940982034b75264be...v1.0.0
+[1.0.0t]: https://gitlab.com/ruby-oauth/version_gem/-/tags/v1.0.0

CONTRIBUTING.md

@@ -5,7 +5,6 @@ This project should be a safe, welcoming space for collaboration, so contributor
 the [code of conduct][🤝conduct].
 
 To submit a patch, please fork the project, create a patch with tests, and send a pull request.
-Post a message to the [google group][⛳mail-list] if you want to.
 
 Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
 
@@ -147,7 +146,9 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
 
 #### Automated process
 
-Run `bundle exec kettle-release`.
+1. Update version.rb to contian the correct version-to-be-released.
+2. Run `bundle exec kettle-changelog`.
+3. Run `bundle exec kettle-release`.
 
 #### Manual process
 
@@ -176,7 +177,6 @@ Run `bundle exec kettle-release`.
 13. Run `bundle exec rake release` which will create a git tag for the version,
     push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
 
-[⛳mail-list]: http://groups.google.com/group/oauth-ruby
 [📜src-gl]: https://gitlab.com/ruby-oauth/version_gem/
 [📜src-cb]: https://codeberg.org/ruby-oauth/version_gem
 [📜src-gh]: https://github.com/ruby-oauth/version_gem

version_gem.gemspec

@@ -113,28 +113,50 @@ Gem::Specification.new do |spec|
 
   # Dev, Test, & Release Tasks
   spec.add_development_dependency("kettle-dev", "~> 1.1", ">= 1.1.1")               # ruby >= 2.3.0
+
+  # Security
   spec.add_development_dependency("bundler-audit", "~> 0.9.2")                      # ruby >= 2.0.0
 
+  # Tasks
   spec.add_development_dependency("rake", "~> 13.0")                                # ruby >= 2.2.0
 
+  # Debugging
   spec.add_development_dependency("require_bench", "~> 1.0", ">= 1.0.4")            # ruby >= 2.2.0
 
+  # Testing
   spec.add_development_dependency("appraisal2", "~> 3.0")                           # ruby >= 1.8.7, for testing against multiple versions of dependencies
-
   spec.add_development_dependency("kettle-test", "~> 1.0")                          # ruby >= 2.3
-
   spec.add_development_dependency("rspec-pending_for")                                # ruby >= 2.3, used to skip specs on incompatible Rubies
 
+  # Releasing
   spec.add_development_dependency("ruby-progressbar", "~> 1.13")                    # ruby >= 0
-
   spec.add_development_dependency("stone_checksums", "~> 1.0", ">= 1.0.2")          # ruby >= 2.2.0
 
-  # spec.add_development_dependency("erb", ">= 2.2")                                  # ruby >= 2.3.0, not SemVer, old rubies get dropped in a patch.
+  # Git integration (optional)
+  # The 'git' gem is optional; version_gem falls back to shelling out to `git` if it is not present.
+  # The current release of the git gem depends on activesupport, which makes it too heavy to depend on directly
+  # spec.add_dependency("git", ">= 1.19.1")                               # ruby >= 2.3
 
+  # Development tasks
+  # The cake is a lie. erb v2.2, the oldest release on RubyGems.org, was never compatible with Ruby 2.3.
+  # This means we have no choice but to use the erb that shipped with Ruby 2.3
+  # /opt/hostedtoolcache/Ruby/2.3.8/x64/lib/ruby/gems/2.3.0/gems/erb-2.2.2/lib/erb.rb:670:in `prepare_trim_mode': undefined method `match?' for "-":String (NoMethodError)
+  # spec.add_development_dependency("erb", ">= 2.2")                                  # ruby >= 2.3.0, not SemVer, old rubies get dropped in a patch.
   spec.add_development_dependency("gitmoji-regex", "~> 1.0", ">= 1.0.3")            # ruby >= 2.3.0
 
+  # HTTP recording for deterministic specs
+  # It seems that somehow just having a newer version of appraisal installed breaks
+  #   Ruby 2.3 and 2.4 even if their bundle specifies an older version,
+  #   and as a result it can only be a dependency in the appraisals.
+  # | An error occurred while loading spec_helper.
+  # | Failure/Error: require "vcr"
+  # |
+  # | NoMethodError:
+  # |   undefined method `delete_prefix' for "CONTENT_LENGTH":String
+  # | # ./spec/config/vcr.rb:3:in `require'
+  # | # ./spec/config/vcr.rb:3:in `<top (required)>'
+  # | # ./spec/spec_helper.rb:8:in `require_relative'
+  # | # ./spec/spec_helper.rb:8:in `<top (required)>'
   # spec.add_development_dependency("vcr", ">= 4")                      # 6.0 claims to support ruby >= 2.3, but fails on ruby 2.4
-
   # spec.add_development_dependency("webmock", ">= 3")               # Last version to support ruby >= 2.3
-
 end