From 77cf05a832a41bb8c2749a300aaea3fa31c65479 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 12 Aug 2025 11:11:58 +0300 Subject: [PATCH 01/25] chore(deps): bump actions/checkout from 4 to 5 (#127) --- .github/workflows/commit-check.yml | 2 +- .github/workflows/main.yaml | 2 +- .github/workflows/used-by.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/commit-check.yml b/.github/workflows/commit-check.yml index f75de56..b22e048 100644 --- a/.github/workflows/commit-check.yml +++ b/.github/workflows/commit-check.yml @@ -12,7 +12,7 @@ jobs: contents: read pull-requests: write steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 with: ref: ${{ github.event.pull_request.head.sha }} # checkout PR HEAD commit fetch-depth: 0 # fetch all history for all branches and tags diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index 913593d..b4a7f0d 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -19,7 +19,7 @@ jobs: re-tag: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 with: fetch-depth: 0 ref: ${{ inputs.ref }} diff --git a/.github/workflows/used-by.yml b/.github/workflows/used-by.yml index 0625b49..fae6e88 100644 --- a/.github/workflows/used-by.yml +++ b/.github/workflows/used-by.yml @@ -14,7 +14,7 @@ jobs: used-by: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - uses: shenxianpeng/used-by@v0.1.4 with: repo: '${{ github.repository }}' From ea1ae5cc4f3e8ab71676ba9b51152fdc812ace52 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Tue, 19 Aug 2025 22:08:00 +0300 Subject: [PATCH 02/25] chore: update and rename main.yaml to release.yaml (#129) --- .github/workflows/{main.yaml => release.yaml} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename .github/workflows/{main.yaml => release.yaml} (96%) diff --git a/.github/workflows/main.yaml b/.github/workflows/release.yaml similarity index 96% rename from .github/workflows/main.yaml rename to .github/workflows/release.yaml index b4a7f0d..a9edb15 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/release.yaml @@ -1,9 +1,9 @@ -name: Main +name: Release on: release: branches: [main] - types: [published] + types: [released] workflow_dispatch: inputs: tag: From 1a0695bffb51d20f90f059c7c0b54b537ee61be8 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Tue, 19 Aug 2025 22:13:38 +0300 Subject: [PATCH 03/25] docs: update README.md to move a badge --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 478a8d4..163cd76 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Commit-Check GitHub Action -[![Main](https://github.com/commit-check/commit-check-action/actions/workflows/main.yaml/badge.svg)](https://github.com/commit-check/commit-check-action/actions/workflows/main.yaml) [![Commit Check](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml/badge.svg)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/commit-check/commit-check-action) [![Used by](https://img.shields.io/static/v1?label=Used%20by&message=67&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) From 4d869c9231db21d02461d6330ad04d724c0b3ca6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 25 Aug 2025 12:59:08 +0300 Subject: [PATCH 04/25] chore: update used-by badge by github-actions[bot] (#125) Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 163cd76..06fcc86 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Commit Check](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml/badge.svg)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/commit-check/commit-check-action) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=67&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action) [![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69) From a36334daa1e18458d82ba2c54fc2fa716eae3faf Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 02:59:34 +0300 Subject: [PATCH 05/25] chore(deps): bump pygithub from 2.7.0 to 2.8.1 (#138) --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index e5ff28b..50651fe 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,4 +2,4 @@ # For details please see: https://github.com/commit-check/commit-check commit-check==0.10.1 # Interact with the GitHub API. -PyGithub==2.7.0 +PyGithub==2.8.1 From 857cc3c18b53099b8b4dd7c144530885fbe69e53 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 04:20:35 +0300 Subject: [PATCH 06/25] chore(deps): bump commit-check from 0.10.1 to 0.10.2 (#137) Bumps [commit-check](https://github.com/commit-check/commit-check) from 0.10.1 to 0.10.2. - [Release notes](https://github.com/commit-check/commit-check/releases) - [Commits](https://github.com/commit-check/commit-check/compare/v0.10.1...v0.10.2) --- updated-dependencies: - dependency-name: commit-check dependency-version: 0.10.2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 50651fe..133fa28 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ # Install commit-check CLI # For details please see: https://github.com/commit-check/commit-check -commit-check==0.10.1 +commit-check==0.10.2 # Interact with the GitHub API. PyGithub==2.8.1 From 8079416d15d2ab4a0af0152510b57077a32a0e7d Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Thu, 4 Sep 2025 04:29:38 +0300 Subject: [PATCH 07/25] fix: Workflow does not contain permissions (#139) Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> --- .github/workflows/release.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index a9edb15..10087ef 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -1,4 +1,6 @@ name: Release +permissions: + contents: write on: release: From 3cc934cf58039833e50200fa9221ce79221781c4 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Thu, 4 Sep 2025 04:30:00 +0300 Subject: [PATCH 08/25] fix: Workflow does not contain permissions (#140) Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> --- .github/workflows/pre-commit.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index 7ee1b19..83151fa 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -1,4 +1,6 @@ name: Run pre-commit +permissions: + contents: read on: push: From 4d2f3846a694e87acb6b544574bdbee1de286177 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Thu, 4 Sep 2025 04:30:19 +0300 Subject: [PATCH 09/25] fix: Workflow does not contain permissions (#141) Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> --- .github/workflows/release-drafter.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index d25c13e..026bcaf 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -1,4 +1,6 @@ name: Release Drafter +permissions: + contents: read on: push: From d627c141cd667d09d58245154a10cb995892eb9e Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Thu, 4 Sep 2025 04:32:43 +0300 Subject: [PATCH 10/25] Revert "fix: Workflow does not contain permissions (#141)" (#142) This reverts commit 4d2f3846a694e87acb6b544574bdbee1de286177. --- .github/workflows/release-drafter.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml index 026bcaf..d25c13e 100644 --- a/.github/workflows/release-drafter.yml +++ b/.github/workflows/release-drafter.yml @@ -1,6 +1,4 @@ name: Release Drafter -permissions: - contents: read on: push: From 04667fa89b3d3feb0f28facf9c5ff944a5500e85 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Thu, 11 Sep 2025 19:49:37 +0300 Subject: [PATCH 11/25] fix: eliminate deprecation warnings during GitHub authentication (#145) --- main.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/main.py b/main.py index ef9c920..8a57c64 100755 --- a/main.py +++ b/main.py @@ -3,7 +3,7 @@ import sys import subprocess import re -from github import Github # type: ignore +from github import Github, Auth # type: ignore # Constants for message titles @@ -124,7 +124,10 @@ def add_pr_comments() -> int: raise ValueError("GITHUB_REF environment variable is not set") # Initialize GitHub client - g = Github(token) + # Use new Auth API to avoid deprecation warning + if not token: + raise ValueError("GITHUB_TOKEN is not set") + g = Github(auth=Auth.Token(token)) repo = g.get_repo(repo_name) pull_request = repo.get_issue(int(pr_number)) From f55720f4abe088099ada705679e3b05622821ca5 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Fri, 12 Sep 2025 02:08:17 +0300 Subject: [PATCH 12/25] docs: update example and badge in readme (#146) --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 06fcc86..424d8b5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Commit-Check GitHub Action -[![Commit Check](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml/badge.svg)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml) -![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/commit-check/commit-check-action) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) +[![Commit Check](https://img.shields.io/github/actions/workflow/status/commit-check/commit-check-action/commit-check.yml?branch=main&label=Commit%20Check&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml) +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/commit-check/commit-check-action?color=blue) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=informational&logo=slickpic?color=blue)](https://github.com/commit-check/commit-check-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action) -[![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69) +[![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg?color=blue)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69) A GitHub Action for checking commit message formatting, branch naming, committer name, email, commit signoff, and more. @@ -36,7 +36,7 @@ jobs: contents: read pull-requests: write steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 with: ref: ${{ github.event.pull_request.head.sha }} # checkout PR HEAD commit fetch-depth: 0 # required for merge-base check From 978b3a8247a6003abfb7aad000c8282c7ba13c65 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 15 Sep 2025 12:49:14 +0300 Subject: [PATCH 13/25] chore: automatically update used-by badge (#150) * chore: update used-by badge by github-actions[bot] * docs: add used by RLinf to README --------- Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> Co-authored-by: Xianpeng Shen --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 424d8b5..29e511d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Commit Check](https://img.shields.io/github/actions/workflow/status/commit-check/commit-check-action/commit-check.yml?branch=main&label=Commit%20Check&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/commit-check/commit-check-action?color=blue) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=informational&logo=slickpic?color=blue)](https://github.com/commit-check/commit-check-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=72&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action) [![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg?color=blue)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69) @@ -72,6 +72,8 @@ jobs: Chainlift   Mila Mila   + RLinf + RLinf   and many more.

From a7f1b1ec4729748d035323f1cf93d8f45e9b76c5 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Wed, 17 Sep 2025 04:10:01 +0300 Subject: [PATCH 14/25] docs: fix capitalization in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 29e511d..3171c14 100644 --- a/README.md +++ b/README.md @@ -82,13 +82,13 @@ jobs: ### `message` - **Description**: check commit message formatting convention. - - By default, the rule follows [conventional commits](https://www.conventionalcommits.org/). + - By default, the rule follows [Conventional Commits](https://www.conventionalcommits.org/). - Default: `true` ### `branch` - **Description**: check git branch naming convention. - - By default, the rule follows [conventional branch](https://conventional-branch.github.io/). + - By default, the rule follows [Conventional Branch](https://conventional-branch.github.io/). - Default: `true` ### `author-name` From 09d59e4c7826ba9b97bcddef18248d8dba026eab Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 6 Oct 2025 13:15:26 +0300 Subject: [PATCH 15/25] chore: update used-by badge by github-actions[bot] (#151) Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3171c14..1feaa9c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Commit Check](https://img.shields.io/github/actions/workflow/status/commit-check/commit-check-action/commit-check.yml?branch=main&label=Commit%20Check&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/commit-check/commit-check-action?color=blue) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=72&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=75&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action) [![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg?color=blue)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69) From d009e35187a28857656c738120c6be00c6e0d92a Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Tue, 14 Oct 2025 09:39:12 +0300 Subject: [PATCH 16/25] BREAKING CHNAGE: Upgrade commit-check to v2.0.0 (#152) * BREAKING CHNAGES: upgrade commit-check to v2.0.0 * BREAKING CHNAGE: remove options * chore!: remove options * chore: update code comments * feat!: change default values and update docs * docs: update README.md * docs: update README.md * fix: update sha to ref * test: update require_rebase_target * docs: update README.md --- .commit-check.yml | 30 ---------------- .github/workflows/commit-check.yml | 9 ++--- .github/workflows/release.yaml | 12 +++---- README.md | 57 ++++++++++++------------------ action.yml | 21 ++--------- commit-check.toml | 23 ++++++++++++ main.py | 12 ------- requirements.txt | 2 +- 8 files changed, 58 insertions(+), 108 deletions(-) delete mode 100644 .commit-check.yml create mode 100644 commit-check.toml diff --git a/.commit-check.yml b/.commit-check.yml deleted file mode 100644 index f1f725f..0000000 --- a/.commit-check.yml +++ /dev/null @@ -1,30 +0,0 @@ -checks: - - - check: message - regex: '^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\([\w\-\.]+\))?(!)?: ([\w ])+([\s\S]*)|(Merge).*|(fixup!.*)' - error: "The commit message should be structured as follows:\n\n - [optional scope]: \n - [optional body]\n - [optional footer(s)]\n\n - More details please refer to https://www.conventionalcommits.org" - suggest: please check your commit message whether matches above regex - - - check: branch - regex: ^(bugfix|feature|release|hotfix|task|chore)\/.+|(master)|(main)|(HEAD)|(PR-.+) - error: "Branches must begin with these types: bugfix/ feature/ release/ hotfix/ task/ chore/" - suggest: run command `git checkout -b type/branch_name` - - - check: author_name - regex: ^[A-Za-zÀ-ÖØ-öø-ÿ\u0100-\u017F\u0180-\u024F ,.\'-]+$|.*(\[bot]) - error: The committer name seems invalid - suggest: run command `git config user.name "Your Name"` - - - check: author_email - regex: ^.+@.+$ - error: The committer email seems invalid - suggest: run command `git config user.email yourname@example.com` - - - check: merge_base - regex: main # it can be master, develop, devel etc based on your project. - error: Current branch is not rebased onto target branch - suggest: please ensure your branch is rebased with the target branch diff --git a/.github/workflows/commit-check.yml b/.github/workflows/commit-check.yml index b22e048..01ee50a 100644 --- a/.github/workflows/commit-check.yml +++ b/.github/workflows/commit-check.yml @@ -14,18 +14,15 @@ jobs: steps: - uses: actions/checkout@v5 with: - ref: ${{ github.event.pull_request.head.sha }} # checkout PR HEAD commit - fetch-depth: 0 # fetch all history for all branches and tags + ref: ${{ github.event.pull_request.head.ref }} # Checkout PR branch + fetch-depth: 0 # Required for merge-base checks - uses: ./ # self test env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because of use pr-comments + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed for PR comments with: message: true branch: true author-name: true author-email: true - commit-signoff: true - merge-base: true - imperative: true job-summary: true pr-comments: ${{ github.event_name == 'pull_request' }} diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 10087ef..54b1e22 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -10,7 +10,7 @@ on: inputs: tag: description: 'which tag to update to' - default: 'v1' + default: 'v2' required: true ref: description: 'which branch to update the tag on' @@ -36,10 +36,10 @@ jobs: git push --delete origin ${{ inputs.tag }} || true git tag -a ${{ inputs.tag }} -m 'Retag ${{ inputs.tag }}' git push origin ${{ inputs.tag }} - - name: Update tag to v1 + - name: Update tag to v2 if: github.event.inputs.tag == '' run: | - git tag --delete v1 || true - git push --delete origin v1 || true - git tag -a v1 -m 'Retag v1' - git push origin v1 + git tag --delete v2 || true + git push --delete origin v2 || true + git tag -a v2 -m 'Retag v2' + git push origin v2 diff --git a/README.md b/README.md index 1feaa9c..f3d1c89 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,18 @@ A GitHub Action for checking commit message formatting, branch naming, committer name, email, commit signoff, and more. +## What's New in v2 + +> [!IMPORTANT] +> This v2 release introduces several 🚨**breaking changes**. Please review the [Breaking Changes](#breaking-changes) section carefully before upgrading. + +### Breaking Changes + +- Removed support for `commit-signoff`, `merge-base`, and `imperative` inputs — now configured via `commit-check.toml` or `cchk.toml`. +- Deprecated `.commit-check.yml` in favor of `commit-check.toml` or `cchk.toml`. +- Changed default values of `author-name` and `author-email` inputs to `false` to align with the default behavior in commit-check. +- Upgraded core dependency [`commit-check`](https://github.com/commit-check/commit-check) to [**v2.0.0**](https://github.com/commit-check/commit-check/releases/tag/v2.0.0). + ## Table of Contents * [Usage](#usage) @@ -38,19 +50,16 @@ jobs: steps: - uses: actions/checkout@v5 with: - ref: ${{ github.event.pull_request.head.sha }} # checkout PR HEAD commit - fetch-depth: 0 # required for merge-base check - - uses: commit-check/commit-check-action@v1 + ref: ${{ github.event.pull_request.head.ref }} # Checkout PR branch + fetch-depth: 0 # Required for merge-base checks + - uses: commit-check/commit-check-action@v2 env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # use GITHUB_TOKEN because use of pr-comments + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed for PR comments with: message: true branch: true - author-name: true - author-email: true - commit-signoff: true - merge-base: false - imperative: false + author-name: false + author-email: false job-summary: true pr-comments: ${{ github.event_name == 'pull_request' }} ``` @@ -81,44 +90,22 @@ jobs: ### `message` -- **Description**: check commit message formatting convention. - - By default, the rule follows [Conventional Commits](https://www.conventionalcommits.org/). +- **Description**: check git commit message following [Conventional Commits](https://www.conventionalcommits.org/). - Default: `true` ### `branch` -- **Description**: check git branch naming convention. - - By default, the rule follows [Conventional Branch](https://conventional-branch.github.io/). +- **Description**: check git branch name following [Conventional Branch](https://conventional-branch.github.io/). - Default: `true` ### `author-name` - **Description**: check committer author name. -- Default: `true` +- Default: `false` ### `author-email` - **Description**: check committer author email. -- Default: `true` - -### `commit-signoff` - -- **Description**: check committer commit signature. -- Default: `true` - -### `merge-base` - -- **Description**: check current branch is rebased onto the target branch. -- Default: `false` - -> [!IMPORTANT] -> `merge-base` is an experimental feature. By default, it's disabled. -> -> To use this feature, you need to fetch all history for all branches by setting `fetch-depth: 0` in `actions/checkout`. - -### `imperative` - -- **Description**: check commit message is imperative mood. - Default: `false` ### `dry-run` @@ -141,7 +128,7 @@ jobs: > > This feature currently doesn’t work with forked repositories. For more details, refer to issue [#77](https://github.com/commit-check/commit-check-action/issues/77). -Note: the default rule of above inputs is following [this configuration](https://github.com/commit-check/commit-check/blob/main/.commit-check.yml). If you want to customize, just add your `.commit-check.yml` config file under your repository root directory. +Note: the default rule of above inputs is following [this configuration](https://github.com/commit-check/commit-check-action/blob/main/commit-check.toml). If you want to customize, just add your [`commit-check.toml`](https://commit-check.github.io/commit-check/configuration.html) config file under your repository root directory. ## GitHub Action Job Summary diff --git a/action.yml b/action.yml index eb12512..68df492 100644 --- a/action.yml +++ b/action.yml @@ -6,32 +6,20 @@ branding: color: "blue" inputs: message: - description: check commit message formatting convention + description: check git commit message following conventional commits required: false default: true branch: - description: check git branch naming convention + description: check git branch name following conventional branch required: false default: true author-name: description: check committer author name required: false - default: true + default: false author-email: description: check committer author email required: false - default: true - commit-signoff: - description: check committer commit signature - required: false - default: true - merge-base: - description: check current branch is rebased onto target branch - required: false - default: false - imperative: - description: check commit message is in imperative mood - required: false default: false dry-run: description: run checks without failing @@ -78,9 +66,6 @@ runs: BRANCH: ${{ inputs.branch }} AUTHOR_NAME: ${{ inputs.author-name }} AUTHOR_EMAIL: ${{ inputs.author-email }} - COMMIT_SIGNOFF: ${{ inputs.commit-signoff }} - MERGE_BASE: ${{ inputs.merge-base }} - IMPERATIVE: ${{ inputs.imperative }} DRY_RUN: ${{ inputs.dry-run }} JOB_SUMMARY: ${{ inputs.job-summary }} PR_COMMENTS: ${{ inputs.pr-comments }} diff --git a/commit-check.toml b/commit-check.toml new file mode 100644 index 0000000..5eec90c --- /dev/null +++ b/commit-check.toml @@ -0,0 +1,23 @@ +[commit] +# https://www.conventionalcommits.org +conventional_commits = true +subject_capitalized = false +subject_imperative = true +subject_max_length = 80 +subject_min_length = 5 +allow_commit_types = ["feat", "fix", "docs", "style", "refactor", "test", "chore", "ci"] +allow_merge_commits = true +allow_revert_commits = true +allow_empty_commits = false +allow_fixup_commits = true +allow_wip_commits = false +require_body = false +require_signed_off_by = false +ignore_authors = ["dependabot[bot]", "copilot[bot]", "pre-commit-ci[bot]"] + +[branch] +# https://conventional-branch.github.io/ +conventional_branch = true +allow_branch_types = ["feature", "bugfix", "hotfix", "release", "chore", "feat", "fix"] +require_rebase_target = "origin/main" +ignore_authors = ["dependabot[bot]", "copilot[bot]", "pre-commit-ci[bot]"] diff --git a/main.py b/main.py index 8a57c64..2ec7ea5 100755 --- a/main.py +++ b/main.py @@ -15,9 +15,6 @@ BRANCH = os.getenv("BRANCH", "false") AUTHOR_NAME = os.getenv("AUTHOR_NAME", "false") AUTHOR_EMAIL = os.getenv("AUTHOR_EMAIL", "false") -COMMIT_SIGNOFF = os.getenv("COMMIT_SIGNOFF", "false") -MERGE_BASE = os.getenv("MERGE_BASE", "false") -IMPERATIVE = os.getenv("IMPERATIVE", "true") DRY_RUN = os.getenv("DRY_RUN", "false") JOB_SUMMARY = os.getenv("JOB_SUMMARY", "false") PR_COMMENTS = os.getenv("PR_COMMENTS", "false") @@ -33,9 +30,6 @@ def log_env_vars(): print(f"BRANCH = {BRANCH}") print(f"AUTHOR_NAME = {AUTHOR_NAME}") print(f"AUTHOR_EMAIL = {AUTHOR_EMAIL}") - print(f"COMMIT_SIGNOFF = {COMMIT_SIGNOFF}") - print(f"MERGE_BASE = {MERGE_BASE}") - print(f"IMPERATIVE = {IMPERATIVE}") print(f"DRY_RUN = {DRY_RUN}") print(f"JOB_SUMMARY = {JOB_SUMMARY}") print(f"PR_COMMENTS = {PR_COMMENTS}\n") @@ -48,9 +42,6 @@ def run_commit_check() -> int: "--branch", "--author-name", "--author-email", - "--commit-signoff", - "--merge-base", - "--imperative", ] args = [ arg @@ -61,9 +52,6 @@ def run_commit_check() -> int: BRANCH, AUTHOR_NAME, AUTHOR_EMAIL, - COMMIT_SIGNOFF, - MERGE_BASE, - IMPERATIVE, ], ) if value == "true" diff --git a/requirements.txt b/requirements.txt index 133fa28..27bbca8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ # Install commit-check CLI # For details please see: https://github.com/commit-check/commit-check -commit-check==0.10.2 +commit-check==2.0.0 # Interact with the GitHub API. PyGithub==2.8.1 From ec301fee109c5180270b1d3e0c17c49c192cc28a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 14 Oct 2025 20:24:57 +0300 Subject: [PATCH 17/25] chore: update used-by badge by github-actions[bot] (#153) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f3d1c89..437e584 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Commit Check](https://img.shields.io/github/actions/workflow/status/commit-check/commit-check-action/commit-check.yml?branch=main&label=Commit%20Check&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/commit-check/commit-check-action?color=blue) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=75&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=77&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action) [![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg?color=blue)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69) From fc0543792ea1ba666c86fea9792d1d72e253ca97 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Oct 2025 23:51:52 +0300 Subject: [PATCH 18/25] chore(deps): bump commit-check from 2.0.0 to 2.1.0 (#155) Bumps [commit-check](https://github.com/commit-check/commit-check) from 2.0.0 to 2.1.0. - [Release notes](https://github.com/commit-check/commit-check/releases) - [Changelog](https://github.com/commit-check/commit-check/blob/main/docs/changelog.rst) - [Commits](https://github.com/commit-check/commit-check/compare/v2.0.0...v2.1.0) --- updated-dependencies: - dependency-name: commit-check dependency-version: 2.1.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 27bbca8..2156f7d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ # Install commit-check CLI # For details please see: https://github.com/commit-check/commit-check -commit-check==2.0.0 +commit-check==2.1.0 # Interact with the GitHub API. PyGithub==2.8.1 From a4daf2b319722bf056b0809dfae4d97feb4ebe7d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 5 Nov 2025 03:59:37 +0200 Subject: [PATCH 19/25] chore(deps): bump commit-check from 2.1.0 to 2.1.1 (#158) --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 2156f7d..64a0196 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ # Install commit-check CLI # For details please see: https://github.com/commit-check/commit-check -commit-check==2.1.0 +commit-check==2.1.1 # Interact with the GitHub API. PyGithub==2.8.1 From 5185641addf183421c036d74e279a465b1ba70fb Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Thu, 6 Nov 2025 00:07:58 +0200 Subject: [PATCH 20/25] feat: remove requiring `ref` in action/checkout (#162) --- .github/workflows/commit-check.yml | 1 - README.md | 1 - 2 files changed, 2 deletions(-) diff --git a/.github/workflows/commit-check.yml b/.github/workflows/commit-check.yml index 01ee50a..7971a30 100644 --- a/.github/workflows/commit-check.yml +++ b/.github/workflows/commit-check.yml @@ -14,7 +14,6 @@ jobs: steps: - uses: actions/checkout@v5 with: - ref: ${{ github.event.pull_request.head.ref }} # Checkout PR branch fetch-depth: 0 # Required for merge-base checks - uses: ./ # self test env: diff --git a/README.md b/README.md index 437e584..530b4c9 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,6 @@ jobs: steps: - uses: actions/checkout@v5 with: - ref: ${{ github.event.pull_request.head.ref }} # Checkout PR branch fetch-depth: 0 # Required for merge-base checks - uses: commit-check/commit-check-action@v2 env: From a0193b1ca486178b85d7a1db145af34cd227f81f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 6 Nov 2025 00:09:40 +0200 Subject: [PATCH 21/25] chore(deps): bump commit-check from 2.1.1 to 2.1.2 (#161) Bumps [commit-check](https://github.com/commit-check/commit-check) from 2.1.1 to 2.1.2. - [Release notes](https://github.com/commit-check/commit-check/releases) - [Changelog](https://github.com/commit-check/commit-check/blob/main/docs/changelog.rst) - [Commits](https://github.com/commit-check/commit-check/compare/v2.1.1...v2.1.2) --- updated-dependencies: - dependency-name: commit-check dependency-version: 2.1.2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 64a0196..830b52a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ # Install commit-check CLI # For details please see: https://github.com/commit-check/commit-check -commit-check==2.1.1 +commit-check==2.1.2 # Interact with the GitHub API. PyGithub==2.8.1 From 6e021a9a707719a6f40e3b3de9ee1b855a243943 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 9 Nov 2025 00:33:53 +0200 Subject: [PATCH 22/25] chore: update used-by badge by github-actions[bot] (#157) Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 530b4c9..8e56f55 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Commit Check](https://img.shields.io/github/actions/workflow/status/commit-check/commit-check-action/commit-check.yml?branch=main&label=Commit%20Check&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/commit-check/commit-check-action?color=blue) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=77&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=95&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action) [![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg?color=blue)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69) From ccb9ad912d0e7047c41fdb23ba39bd9144c339a8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 25 Nov 2025 01:18:31 +0200 Subject: [PATCH 23/25] chore(deps): bump actions/checkout from 5 to 6 (#166) Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v5...v6) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/commit-check.yml | 2 +- .github/workflows/release.yaml | 2 +- .github/workflows/used-by.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/commit-check.yml b/.github/workflows/commit-check.yml index 7971a30..d9faf0e 100644 --- a/.github/workflows/commit-check.yml +++ b/.github/workflows/commit-check.yml @@ -12,7 +12,7 @@ jobs: contents: read pull-requests: write steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 with: fetch-depth: 0 # Required for merge-base checks - uses: ./ # self test diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 54b1e22..4e0f9b2 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -21,7 +21,7 @@ jobs: re-tag: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 with: fetch-depth: 0 ref: ${{ inputs.ref }} diff --git a/.github/workflows/used-by.yml b/.github/workflows/used-by.yml index fae6e88..e1aa9de 100644 --- a/.github/workflows/used-by.yml +++ b/.github/workflows/used-by.yml @@ -14,7 +14,7 @@ jobs: used-by: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v5 + - uses: actions/checkout@v6 - uses: shenxianpeng/used-by@v0.1.4 with: repo: '${{ github.repository }}' From ed35ee08c2332753d7734c27f362deb27cc5e26d Mon Sep 17 00:00:00 2001 From: Petr Ruzicka Date: Fri, 5 Dec 2025 22:31:14 +0100 Subject: [PATCH 24/25] fix: use env in steps instead of inputs in bash code (#167) --- .github/workflows/release.yaml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 4e0f9b2..2e6068d 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -31,11 +31,13 @@ jobs: git config user.email '41898282+github-actions[bot]@users.noreply.github.com' - name: Update tag with parameter if: github.event.inputs.tag != '' + env: + TAG: ${{ inputs.tag }} run: | - git tag --delete ${{ inputs.tag }} || true - git push --delete origin ${{ inputs.tag }} || true - git tag -a ${{ inputs.tag }} -m 'Retag ${{ inputs.tag }}' - git push origin ${{ inputs.tag }} + git tag --delete "$TAG" || true + git push --delete origin "$TAG" || true + git tag -a "$TAG" -m "Retag $TAG" + git push origin "$TAG" - name: Update tag to v2 if: github.event.inputs.tag == '' run: | From 8cc66f7ddeedef7c6cc401f56b276352e3922102 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 8 Dec 2025 14:52:33 +0200 Subject: [PATCH 25/25] chore: update used-by badge by github-actions[bot] (#168) Co-authored-by: shenxianpeng <3353385+shenxianpeng@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e56f55..3924cab 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Commit Check](https://img.shields.io/github/actions/workflow/status/commit-check/commit-check-action/commit-check.yml?branch=main&label=Commit%20Check&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/commit-check/commit-check-action?color=blue) -[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=95&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=101&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents) [![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action) [![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg?color=blue)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69)