diff --git a/.commit-check.yml b/.commit-check.yml index 5f48f93..bde24ab 100644 --- a/.commit-check.yml +++ b/.commit-check.yml @@ -9,8 +9,8 @@ checks: suggest: please check your commit message whether matches above regex - check: branch - regex: ^(bugfix|feature|release|hotfix|task)\/.+|(master)|(main)|(HEAD)|(PR-.+) - error: "Branches must begin with these types: bugfix/ feature/ release/ hotfix/ task/" + 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 diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 6f24ab5..ee8099e 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -8,7 +8,7 @@ body: value: >- Hi there! - We'd appreciate it if you could search on commit-check's existing issues prior to filing + We'd appreciate it if you could search on commit-check's existing issues before filing a feature request. - type: textarea @@ -23,9 +23,9 @@ body: attributes: label: Describe the solution you'd like description: >- - Clear and concise description of what you want to happen. Please use examples - of real world use cases that this would help with, and how it solves the - problem described above. + A clear and concise description of what you want to happen. Please use examples + of real-world use cases that this would help with, and how it solves the + the problem described above. validations: required: true @@ -35,4 +35,4 @@ body: description: >- Add any other context, links, etc. relevant to the feature request. validations: - required: true + required: false diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 263c2dd..d50df5f 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.1 + rev: v0.8.2 hooks: - id: check-message # - id: check-branch # uncomment if you need. diff --git a/README.rst b/README.rst index e60af4e..ff9c7e6 100644 --- a/README.rst +++ b/README.rst @@ -166,9 +166,9 @@ Check Branch Naming Failed Commit rejected. Type branch check failed => my-test-branch - It doesn't match regex: ^(bugfix|feature|release|hotfix|task)\/.+|(master)|(main)|(HEAD)|(PR-.+) + It doesn't match regex: ^(bugfix|feature|release|hotfix|task|chore)\/.+|(master)|(main)|(HEAD)|(PR-.+) - Branches must begin with these types: bugfix/ feature/ release/ hotfix/ task/ + Branches must begin with these types: bugfix/ feature/ release/ hotfix/ task/ chore/ Suggest: run command `git checkout -b type/branch_name` diff --git a/commit_check/__init__.py b/commit_check/__init__.py index 1c5982f..7d1ab0c 100644 --- a/commit_check/__init__.py +++ b/commit_check/__init__.py @@ -26,8 +26,8 @@ }, { 'check': 'branch', - 'regex': r'^(bugfix|feature|release|hotfix|task)\/.+|(master)|(main)|(HEAD)|(PR-.+)', - 'error': 'Branches must begin with these types: bugfix/ feature/ release/ hotfix/ task/', + 'regex': r'^(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`', }, { diff --git a/docs/conf.py b/docs/conf.py index 125dc6e..53d5b56 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,6 +4,7 @@ # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html import re +import datetime from pathlib import Path import io from sphinx.application import Sphinx @@ -12,7 +13,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "commit-check" -copyright = "2023, shenxianpeng" +copyright = f"{datetime.date.today().year}, shenxianpeng" author = "shenxianpeng" # -- General configuration --------------------------------------------------- diff --git a/pyproject.toml b/pyproject.toml index 361ccf0..ffeff98 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,15 +6,15 @@ build-backend = "setuptools.build_meta" name = "commit-check" description = "Check commit message formatting, branch naming, commit author, email, and more." readme = "README.rst" -keywords = ["commit conventions", "conventional commits", "branch naming", "commit-check", "message", "lint message"] +keywords = ["commit conventions", "conventional commits", "conventional branch", "branch naming", "commit-check", "message", "lint message", "devops"] license = {text = "MIT License"} authors = [ - { name = "Peter Shen", email = "xianpeng.shen@gmail.com" }, + { name = "Xianpeng Shen", email = "xianpeng.shen@gmail.com" }, ] dependencies = ["pyyaml"] classifiers = [ # https://pypi.org/pypi?%3Aaction=list_classifiers - "Development Status :: 4 - Beta", + "Development Status :: 5 - Production/Stable", "License :: OSI Approved :: MIT License", "Intended Audience :: Developers", "Natural Language :: English", pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy