[pull] main from compilerla:main

.devcontainer/devcontainer.json

@@ -1,6 +1,6 @@
 {
   "name": "compilerla/conventional-pre-commit",
-  "dockerComposeFile": ["./compose.yml"],
+  "dockerComposeFile": ["../compose.yml"],
   "service": "dev",
   "runServices": ["dev"],
   "workspaceFolder": "/home/compiler/src",

.github/workflows/release.yml

@@ -22,9 +22,9 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.11"
           cache: pip
@@ -36,16 +36,6 @@ jobs:
       - name: Build package
         run: python -m build
 
-      - name: Release
-        id: release
-        uses: softprops/action-gh-release@v2
-        with:
-          files: |
-            ./dist/*.whl
-            ./dist/*.tar.gz
-          prerelease: ${{ contains(github.ref, '-pre') }}
-          generate_release_notes: ${{ !contains(github.ref, '-pre') }}
-
       - name: Publish to Test PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         if: ${{ contains(github.ref, '-pre') }}
@@ -60,3 +50,13 @@ jobs:
         if: ${{ !contains(github.ref, '-pre') }}
         with:
           print-hash: true
+
+      - name: Release
+        id: release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            ./dist/*.whl
+            ./dist/*.tar.gz
+          prerelease: ${{ contains(github.ref, '-pre') }}
+          generate_release_notes: ${{ !contains(github.ref, '-pre') }}

.github/workflows/tests.yml

@@ -25,10 +25,10 @@ jobs:
         python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
           cache: pip

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ default_install_hook_types:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
       - id: mixed-line-ending
@@ -17,22 +17,22 @@ repos:
       - id: check-yaml
       - id: check-added-large-files
 
-  - repo: https://github.com/psf/black
-    rev: 24.4.2
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    rev: 26.3.1
     hooks:
       - id: black
         types:
           - python
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.0
+    rev: 7.3.0
     hooks:
       - id: flake8
         types:
           - python
 
   - repo: https://github.com/pycqa/bandit
-    rev: 1.7.9
+    rev: 1.9.4
     hooks:
       - id: bandit
         args: ["-ll"]
@@ -51,3 +51,4 @@ repos:
         entry: conventional-pre-commit
         language: python
         stages: [commit-msg]
+        args: [--verbose]

README.md

@@ -15,9 +15,13 @@ Create a blank configuration file at the root of your repo, if needed:
 touch .pre-commit-config.yaml
 ```
 
-Add a new repo entry to your configuration file:
+Add/update `default_install_hook_types` and add a new repo entry in your configuration file:
 
 ```yaml
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+
 repos:
   # - repo: ...
 
@@ -32,7 +36,7 @@ repos:
 Install the `pre-commit` script:
 
 ```console
-pre-commit install --hook-type commit-msg
+pre-commit install --install-hooks
 ```
 
 Make a (normal) commit :x::
@@ -46,33 +50,41 @@ Conventional Commit......................................................Failed
 - duration: 0.07s
 - exit code: 1
 
-[Bad Commit message] >> add a new feature
-
+[Bad commit message] >> add a new feature
 Your commit message does not follow Conventional Commits formatting
 https://www.conventionalcommits.org/
+```
 
-Conventional Commits start with one of the below types, followed by a colon,
-followed by the commit message:
+And with the `--verbose` arg:
 
-    build chore ci docs feat fix perf refactor revert style test
+```console
+$ git commit -m "add a new feature"
 
-Example commit message adding a feature:
+[INFO] Initializing environment for ....
+Conventional Commit......................................................Failed
+- hook id: conventional-pre-commit
+- duration: 0.07s
+- exit code: 1
+
+[Bad commit message] >> add a new feature
+Your commit message does not follow Conventional Commits formatting
+https://www.conventionalcommits.org/
 
-    feat: implement new API
+Conventional Commit messages follow a pattern like:
 
-Example commit message fixing an issue:
+    type(scope): subject
 
-    fix: remove infinite loop
+    extended body
 
-Example commit with scope in parentheses after the type for more context:
+Please correct the following errors:
 
-    fix(account): remove infinite loop
+  - Expected value for type from: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test
 
-Example commit with a body:
+Run:
 
-    fix: remove infinite loop
+    git commit --edit --file=.git/COMMIT_EDITMSG
 
-    Additional information on the issue caused by the infinite loop
+to edit the commit message and retry the commit.
 ```
 
 Make a (conventional) commit :heavy_check_mark::
@@ -129,18 +141,21 @@ print(is_conventional("custom: this is a conventional commit", types=["custom"])
 
 ```shell
 $ conventional-pre-commit -h
-usage: conventional-pre-commit [-h] [--force-scope] [--strict] [types ...] input
+usage: conventional-pre-commit [-h] [--no-color] [--force-scope] [--scopes SCOPES] [--strict] [--verbose] [types ...] input
 
 Check a git commit message for Conventional Commits formatting.
 
 positional arguments:
-  types          Optional list of types to support
-  input          A file containing a git commit message
+  types            Optional list of types to support
+  input            A file containing a git commit message
 
 options:
-  -h, --help     show this help message and exit
-  --force-scope  Force commit to have scope defined.
-  --strict       Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.
+  -h, --help       show this help message and exit
+  --no-color       Disable color in output.
+  --force-scope    Force commit to have scope defined.
+  --scopes SCOPES  List of scopes to support. Scopes should be separated by commas with no spaces (e.g. api,client).
+  --strict         Force commit to strictly follow Conventional Commits formatting. Disallows fixup! and merge commits.
+  --verbose        Print more verbose error output.
 ```
 
 Supply arguments on the command-line, or via the pre-commit `hooks.args` property:

.devcontainer/compose.yml → compose.yml

@@ -1,10 +1,10 @@
 services:
   dev:
     build:
-      context: ..
+      context: .
       dockerfile: .devcontainer/Dockerfile
     entrypoint: []
     command: sleep infinity
     image: compilerla/conventional-pre-commit:dev
     volumes:
-      - ../:/home/compiler/src
+      - ./:/home/compiler/src