create_github_release 2.1.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63d1b8c7d18e4955692a4a9e9d89c0065929f8fa4d4dbee32f72e799f872cb1c
-  data.tar.gz: f5f2ab6bf2cc60a876a04619af5c00df60bb0c2045a880c58f5638a35eeae16f
+  metadata.gz: b1ffe83bf7eb474d1753c08012f827cd6b12b628cb137362a9756f37806f704e
+  data.tar.gz: fdbdcf617cf68f32dca8795f90bf8c043c906c7dc892787c0fba8c5533b1bfa7
 SHA512:
-  metadata.gz: fcdc49a635e732484f15267554ea885cc96944c794e83ad751415b26fc8179f1a77e7caec0dd683be0dc0c69c6f24480aaf59d59b096c6c3abf7aead6afe2e2f
-  data.tar.gz: dedf1c21ebe7ccb181d0d38eabc650a2fba5a9912af2df39c7681f8304ee4d9bc4ed3e6a1254c5e53d751f945aa7579bfbfdca62ccb978c599bb792a704425c0
+  metadata.gz: ec45b13b37efbf897edfa721721414c6aeebc5c4cc98ec9a98aaeea0b4e802a278189cc57d89cf2b1d479bc335dc207edebb3d6444b434657ff96b7ba08718c4
+  data.tar.gz: f47b28ec037664696d350d72c458487133af69c2a30bd2389d634acf8ea748d3607a25618e69284e6005c5a1297a165e61d779883ba557d9bf9307f9e2ecaf49

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/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).
 
+## 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)
+
+Changes since v2.1.0:
+
+* d44db95 fix: the release commit subject should not be sentence case
+
 ## v2.1.0 (2024-10-10)
 
 [Full Changelog](https://github.com/main-branch/create_github_release/compare/v2.0.1..v2.1.0)

data/README.md

@@ -6,6 +6,8 @@
 [![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
@@ -40,6 +42,8 @@ Tested on Ruby 3.0+
   * [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 +405,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/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/lib/create_github_release/tasks/commit_release.rb

@@ -31,7 +31,7 @@ module CreateGithubRelease
       #
       def run
         print 'Making release commit...'
-        `git commit -s -m 'chore: Release #{project.next_release_tag}'`
+        `git commit -s -m 'chore: release #{project.next_release_tag}'`
         if $CHILD_STATUS.success?
           puts 'OK'
         else

data/lib/create_github_release/version.rb

@@ -2,5 +2,5 @@
 
 module CreateGithubRelease
   # The version of this gem
-  VERSION = '2.1.0'
+  VERSION = '2.1.2'
 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"
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: create_github_release
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.2
 platform: ruby
 authors:
 - James
@@ -16,28 +16,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 +52,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,6 +251,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".commitlintrc.yml"
+- ".husky/commit-msg"
 - ".markdownlint.yml"
 - ".rspec"
 - ".rubocop.yml"
@@ -291,6 +307,7 @@ 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
 homepage: https://github.com/main-branch/create_github_release
 licenses:
 - MIT
@@ -298,8 +315,8 @@ 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.0
-  changelog_uri: https://rubydoc.info/gems/create_github_release/2.1.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/create_github_release/2.1.2
+  changelog_uri: https://rubydoc.info/gems/create_github_release/2.1.2/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []