create_github_release 2.1.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86f083d1483f3aeea61c0a35aa765b49b364bc6acd7a7636031d77976d5b214b
-  data.tar.gz: 23878e11780006223bc164616ffb1e2e7306174d1f452535e8791a3c1b5af82e
+  metadata.gz: '08c3d00a0f75a3accad80335ab689ec5e8031c31d2dffd2cb5c3e169a8ee0e7b'
+  data.tar.gz: 298c656c98c5e0ab3c82f16ca68136f7ee171835457becda20518524b15b71f7
 SHA512:
-  metadata.gz: a1960299c4f3b862fabade031dcecb68c9fac3eaeb998dc06c9683150a982ca564fe9d01a45844db5bc5faac55057fc2e51e03db5ad1a71a92b692755e664b7a
-  data.tar.gz: f8ec1f69634152a15d9c46d73462e2465e21194dba6aa9437eb7db9abcd11bb8a766364611a7c55e2649e67ae90d81db9c07166a5ade137558117ac4b6a0f977
+  metadata.gz: e116fddb0d27f6f6ddff3a255632bdc1c4156ecedfe834d0eb84aabff7a4d56dc0be031ddddcf75d91b0405624d3b9745d16d13027712c53c204f72d7a3c19c6
+  data.tar.gz: 49ad78a9eca648b551b309fad714a9e48c25a10bc55691a6fbc17dcf8e7058ffa44893531efba53e555b701c0a2041d616b804e12688bdf009ceb0c0bd2c3897

data/.commitlintrc.yml

@@ -0,0 +1,16 @@
+---
+extends: '@commitlint/config-conventional'
+
+rules:
+  # See: https://commitlint.js.org/reference/rules.html
+  #
+  # Rules are made up by a name and a configuration array. The configuration array contains:
+  #
+  # * Severity [0..2]: 0 disable rule, 1 warning if violated, or 2 error if violated
+  # * Applicability [always|never]: never inverts the rule
+  # * Value: value to use for this rule
+  #
+  # Run `npx commitlint --print-config` to see the current setting for all rules.
+  #
+  body-leading-blank:    [2, 'always']
+  footer-leading-blank:  [2, 'always']

data/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "2.1.3"
+}

data/.yardopts

@@ -3,6 +3,4 @@
 --markup-provider=redcarpet
 --markup markdown
 - CHANGELOG.md
-- CONTRIBUTING.md
-- RELEASING.md
 - LICENSE.txt

data/CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.3](https://github.com/main-branch/create_github_release/compare/v2.1.2...v2.1.3) (2025-04-16)
+
+
+### Bug Fixes
+
+* Automate commit-to-publish workflow ([934289d](https://github.com/main-branch/create_github_release/commit/934289d3fad43157982eefe5d4bd65d066ab62cd))
+* Remove yardoc references to files not included in the project ([19b781c](https://github.com/main-branch/create_github_release/commit/19b781c621b0197f53c5edf19ec19c23fc497567))
+
+## v2.1.2 (2024-10-10)
+
+[Full Changelog](https://github.com/main-branch/create_github_release/compare/v2.1.1..v2.1.2)
+
+Changes since v2.1.1:
+
+* 0bb1a31 build: remove semver pr label check
+* 1c5f446 build: enforce conventional commit message formatting
+
 ## v2.1.1 (2024-10-10)
 
 [Full Changelog](https://github.com/main-branch/create_github_release/compare/v2.1.0..v2.1.1)

data/README.md

@@ -4,8 +4,8 @@
 [![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/create_github_release/)
 [![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/create_github_release/file/CHANGELOG.md)
 [![Build Status](https://github.com/main-branch/create_github_release/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/main-branch/create_github_release/actions/workflows/continuous_integration.yml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/b8c0af10b15a0ffeb1a1/maintainability)](https://codeclimate.com/github/main-branch/create_github_release/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/b8c0af10b15a0ffeb1a1/test_coverage)](https://codeclimate.com/github/main-branch/create_github_release/test_coverage)
+[![Conventional
+Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
 [![Slack](https://img.shields.io/badge/slack-main--branch/create__github__release-yellow.svg?logo=slack)](https://main-branch.slack.com/archives/C07NG282N80)
 
 When run in your gem's git worktree, the `create-github-release` script does the
@@ -26,20 +26,22 @@ Tested on Ruby 3.0+
 
 * [Installation](#installation)
 * [Usage](#usage)
-  * [First release using this script when there were NO prior releases](#first-release-using-this-script-when-there-were-no-prior-releases)
-  * [First release using this script when there were prior releases](#first-release-using-this-script-when-there-were-prior-releases)
-  * [Subsequent releases using this script](#subsequent-releases-using-this-script)
-  * [Pre-release versions](#pre-release-versions)
-    * [Creating the first pre-release version for a release](#creating-the-first-pre-release-version-for-a-release)
-    * [Creating subsequent pre-releases](#creating-subsequent-pre-releases)
-    * [Changing the pre-release type](#changing-the-pre-release-type)
-    * [Creating the release after pre-releases](#creating-the-release-after-pre-releases)
-  * [After Running create-github-release](#after-running-create-github-release)
-  * [Reverting `create-github-release`](#reverting-create-github-release)
+    * [First release using this script when there were NO prior releases](#first-release-using-this-script-when-there-were-no-prior-releases)
+    * [First release using this script when there were prior releases](#first-release-using-this-script-when-there-were-prior-releases)
+    * [Subsequent releases using this script](#subsequent-releases-using-this-script)
+    * [Pre-release versions](#pre-release-versions)
+        * [Creating the first pre-release version for a release](#creating-the-first-pre-release-version-for-a-release)
+        * [Creating subsequent pre-releases](#creating-subsequent-pre-releases)
+        * [Changing the pre-release type](#changing-the-pre-release-type)
+        * [Creating the release after pre-releases](#creating-the-release-after-pre-releases)
+    * [After Running create-github-release](#after-running-create-github-release)
+    * [Reverting `create-github-release`](#reverting-create-github-release)
 * [FAQ](#faq)
-  * [How is the changelog updated?](#how-is-the-changelog-updated)
+    * [How is the changelog updated?](#how-is-the-changelog-updated)
 * [Development](#development)
 * [Contributing](#contributing)
+    * [Commit message guidelines](#commit-message-guidelines)
+    * [Pull request guidelines](#pull-request-guidelines)
 * [License](#license)
 
 ## Installation
@@ -401,6 +403,31 @@ To install this gem onto your current Ruby environment, run `bundle exec rake in
 Bug reports and pull requests are welcome on
 [this project's GitHub page](https://github.com/main-branch/create_github_release)
 
+### Commit message guidelines
+
+All commit messages must follow the [Conventional Commits
+standard](https://www.conventionalcommits.org/en/v1.0.0/). This helps us maintain a
+clear and structured commit history, automate versioning, and generate changelogs
+effectively.
+
+To ensure compliance, this project includes:
+
+* A git commit-msg hook that validates your commit messages before they are accepted.
+
+  To activate the hook, you must have node installed and run `npm install`.
+
+* A GitHub Actions workflow that will enforce the Conventional Commit standard as
+  part of the continuous integration pipeline.
+
+  Any commit message that does not conform to the Conventional Commits standard will
+  cause the workflow to fail and not allow the PR to be merged.
+
+### Pull request guidelines
+
+All pull requests must be merged using rebase merges. This ensures that commit
+messages from the feature branch are preserved in the release branch, keeping the
+history clean and meaningful.
+
 ## License
 
 The gem is available as open source under the terms of the

data/Rakefile

@@ -27,6 +27,13 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
+# Make it so that calling `rake release` just calls `rake release:rubygems_push` to
+# avoid creating and pushing a new tag.
+
+Rake::Task['release'].clear
+desc 'Customized release task to avoid creating a new tag'
+task release: 'release:rubygem_push'
+
 CLEAN << 'pkg'
 CLOBBER << 'Gemfile.lock'
 

data/create_github_release.gemspec

@@ -40,10 +40,11 @@ Gem::Specification.new do |spec|
     'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
   ]
 
-  spec.add_dependency 'command_line_boss', '~> 0.1'
-  spec.add_dependency 'version_boss', '~> 0.1'
+  spec.add_dependency 'command_line_boss', '~> 0.2'
+  spec.add_dependency 'version_boss', '~> 0.2'
 
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
+  spec.add_development_dependency 'create_github_release', '~> 2.1'
   # spec.add_development_dependency 'debug', '~> 1.9'
   spec.add_development_dependency 'logger', '~> 1.6'
   spec.add_development_dependency 'main_branch_shared_rubocop_config', '~> 0.1'

data/exe/revert-github-release

@@ -96,6 +96,7 @@ class Parser
 
     Options:
   BANNER
+  private_constant :BANNER
 
   # Define the options for OptionParser
   # @return [void]

data/lib/create_github_release/command_line/validations.rb

@@ -119,7 +119,7 @@ module CreateGithubRelease
         # @return [Boolean]
         # @api private
         def valid?
-          options.quiet == true || options.quiet == false
+          [true, false].include? options.quiet
         end
 
         # Called when valid? is `false` to return the error messages
@@ -137,7 +137,7 @@ module CreateGithubRelease
         # @return [Boolean]
         # @api private
         def valid?
-          options.verbose == true || options.verbose == false
+          [true, false].include? options.verbose
         end
 
         # Called when valid? is `false` to return the error messages

data/lib/create_github_release/version.rb

@@ -2,5 +2,5 @@
 
 module CreateGithubRelease
   # The version of this gem
-  VERSION = '2.1.1'
+  VERSION = '2.1.3'
 end

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "husky": "^9.1.0"
+  },
+  "scripts": {
+    "postinstall": "husky",
+    "prepare": "husky"
+  }
+}

data/release-please-config.json

@@ -0,0 +1,22 @@
+{
+  "bootstrap-sha": "5f3a18d74fb755d31cc4d3dfc9d18a6df4799945",
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "create_github_release",
+      "changelog-path": "CHANGELOG.md",
+      "version-file": "lib/create_github_release/version.rb",
+      "bump-minor-pre-major": true,
+      "bump-patch-for-minor-pre-major": true,
+      "draft": false,
+      "prerelease": false,
+      "include-component-in-tag": false
+    }
+  },
+  "plugins": [
+    {
+      "type": "sentence-case"
+    }
+  ],
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: create_github_release
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.3
 platform: ruby
 authors:
 - James
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: command_line_boss
@@ -16,28 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: version_boss
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +51,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: create_github_release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -237,7 +250,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".commitlintrc.yml"
+- ".husky/commit-msg"
 - ".markdownlint.yml"
+- ".release-please-manifest.json"
 - ".rspec"
 - ".rubocop.yml"
 - ".vscode/launch.json"
@@ -291,6 +307,8 @@ files:
 - lib/create_github_release/tasks/update_changelog.rb
 - lib/create_github_release/tasks/update_version.rb
 - lib/create_github_release/version.rb
+- package.json
+- release-please-config.json
 homepage: https://github.com/main-branch/create_github_release
 licenses:
 - MIT
@@ -298,10 +316,9 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/create_github_release
   source_code_uri: https://github.com/main-branch/create_github_release
-  documentation_uri: https://rubydoc.info/gems/create_github_release/2.1.1
-  changelog_uri: https://rubydoc.info/gems/create_github_release/2.1.1/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/create_github_release/2.1.3
+  changelog_uri: https://rubydoc.info/gems/create_github_release/2.1.3/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -318,8 +335,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - 'Platform: Mac, Linux, or Windows'
 - 'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A script to create a GitHub release for a Ruby Gem
 test_files: []