Merge branch 'master' into issue-1115

Author: marcosdotme

.github/workflows/docspublish.yml

@@ -6,13 +6,44 @@ on:
       - master
 
 jobs:
+  update-cli-screenshots:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip poetry
+          poetry --version
+          poetry install
+      - name: Update CLI screenshots
+        run: |
+          poetry run python scripts/gen_cli_help_screenshots.py
+      - name: Commit and push updated CLI screenshots
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git add docs/images/cli_help
+          git commit -m "docs(cli/screenshots): update CLI screenshots" -m "[skip ci]"
+          git push
+
   publish-documentation:
     runs-on: ubuntu-latest
+    needs: update-cli-screenshots
     steps:
       - uses: actions/checkout@v4
         with:
           token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"
           fetch-depth: 0
+      - name: Pull latest changes
+        run: |
+          git pull origin master
       - name: Set up Python
         uses: actions/setup-python@v5
         with:

.pre-commit-config.yaml

@@ -21,6 +21,7 @@ repos:
         exclude: "tests/((commands|data)/|test_).+"
       - id: trailing-whitespace
         args: [ --markdown-linebreak-ext=md ]
+        exclude: '\.svg$'
       - id: debug-statements
       - id: no-commit-to-branch
       - id: check-merge-conflict
@@ -46,7 +47,7 @@ repos:
         exclude: "poetry.lock"
 
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v3.25.1 # automatically updated by Commitizen
+    rev: v3.26.0 # automatically updated by Commitizen
     hooks:
       - id: commitizen
       - id: commitizen-branch

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v3.26.0 (2024-05-18)
+
+### Feat
+
+- **ci/cd**: automates the generation of CLI screenshots
+
 ## v3.25.1 (2024-05-15)
 
 ### Refactor

commitizen/__version__.py

@@ -1 +1 @@
-__version__ = "3.25.1"
+__version__ = "3.26.0"

docs/images/cli_help/cz___help.svg

@@ -1,5 +1,5 @@
 [tool.commitizen]
-version = "3.25.1"
+version = "3.26.0"
 tag_format = "v$version"
 version_files = [
   "pyproject.toml:version",
@@ -9,7 +9,7 @@ version_files = [
 
 [tool.poetry]
 name = "commitizen"
-version = "3.25.1"
+version = "3.26.0"
 description = "Python commitizen client tool"
 authors = ["Santiago Fraire <santiwilly@gmail.com>"]
 license = "MIT"