From ff2b870950aa0aa91430fcc4d0b939ad3902cb98 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 12 Aug 2024 20:59:53 +0300 Subject: [PATCH 1/6] ci: pre-commit autoupdate (#167) --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 316589e..f6a58ea 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -32,7 +32,7 @@ repos: hooks: - id: codespell - repo: https://github.com/commit-check/commit-check - rev: v0.8.0 + rev: v0.8.1 hooks: - id: check-message # - id: check-branch # uncomment if you need. From c63f047ee72a51c5a225254abe1b2885805e633e Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 30 Aug 2024 10:43:01 +0300 Subject: [PATCH 2/6] ci: pre-commit autoupdate (#168) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit updates: - [github.com/pre-commit/mirrors-mypy: v1.11.1 → v1.11.2](https://github.com/pre-commit/mirrors-mypy/compare/v1.11.1...v1.11.2) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f6a58ea..263c2dd 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -22,7 +22,7 @@ repos: args: [--max-line-length=100, --ignore=E501] exclude: ^commit_check/__init__.py - repo: https://github.com/pre-commit/mirrors-mypy - rev: v1.11.1 + rev: v1.11.2 hooks: - id: mypy additional_dependencies: [types-PyYAML] From a2eafd45e11012d92eea7abbd93bc1aadfe79dff Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Wed, 11 Sep 2024 10:45:29 +0300 Subject: [PATCH 3/6] docs: update README.rst (#169) * docs: update README.rst * docs: update README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 9e4a95e..8e991a4 100644 --- a/README.rst +++ b/README.rst @@ -54,8 +54,8 @@ Use Default Configuration - If you don't set ``.commit-check.yml``, Commit Check will use the `default configuration `_. -- The commit message will follow the rules of `conventional commits `_, - branch naming follow Bitbucket's `branching model `_. +- The commit message will follow the rules of `Conventional Commits `_, + branch naming follow the rules of `Conventional Branch `_. Usage From 8f9dce006eeeb6ed296cd2d426b33bddfd0a39f0 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Thu, 12 Sep 2024 16:28:59 +0300 Subject: [PATCH 4/6] docs: update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 8e991a4..5319761 100644 --- a/README.rst +++ b/README.rst @@ -55,7 +55,7 @@ Use Default Configuration - If you don't set ``.commit-check.yml``, Commit Check will use the `default configuration `_. - The commit message will follow the rules of `Conventional Commits `_, - branch naming follow the rules of `Conventional Branch `_. + branch naming follow the rules of `Conventional Branch `_. Usage From 37114f997c469802b191f0a69ddda7a6262a9131 Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Fri, 13 Sep 2024 13:32:01 +0300 Subject: [PATCH 5/6] docs: update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 5319761..fc20867 100644 --- a/README.rst +++ b/README.rst @@ -55,7 +55,7 @@ Use Default Configuration - If you don't set ``.commit-check.yml``, Commit Check will use the `default configuration `_. - The commit message will follow the rules of `Conventional Commits `_, - branch naming follow the rules of `Conventional Branch `_. + branch naming follow the rules of `Conventional Branch `_. Usage From 51af224f8784ba94f09cb5820612fa9c331e731b Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Tue, 24 Sep 2024 15:11:51 +0300 Subject: [PATCH 6/6] docs: Update README.rst (#171) closes #170 --- README.rst | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index fc20867..e60af4e 100644 --- a/README.rst +++ b/README.rst @@ -30,25 +30,13 @@ Commit Check Overview -------- -Commit Check supports checking commit messages, branch naming, committer name/email, commit signoff, customizing error messages, suggested commands and more. +**Commit Check** is a free, powerful tool that enforces commit metadata standards, including commit message, branch naming, committer name/email, and commit signoff. Fully customizable with error messages and suggested commands, it ensures compliance across teams. -It is a powerful, free solution for individuals and teams aiming to standardize commit message formatting and branch naming, including - -- writing descriptive commit is easy to read -- identify branch according to the branch type -- triggering the specific types of commit/branch CI build -- automatically generate changelogs - -If you're using Bitbucket, it's an open source alternative to `Yet Another Commit Checker `_. +As an alternative to GitHub Enerprise `Metadata restrictions `_ and Bitbucket's paid puglin `Yet Another Commit Checker `_, Commit Check stands out by integrating DevOps principles and Infrastructure as Code (IaC). Configuration ------------- -Use Custom Configuration -~~~~~~~~~~~~~~~~~~~~~~~~ - -Create a config file ``.commit-check.yml`` under your repository's root directory, e.g., `.commit-check.yml `_ - Use Default Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -57,6 +45,10 @@ Use Default Configuration - The commit message will follow the rules of `Conventional Commits `_, branch naming follow the rules of `Conventional Branch `_. +Use Custom Configuration +~~~~~~~~~~~~~~~~~~~~~~~~ + +Create a config file ``.commit-check.yml`` under your repository's root directory, e.g., `.commit-check.yml `_ Usage -----