Merge branch 'master' into feature/custom-validation

Author: benediktziegler

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,7 +1,7 @@
 name: 🛠 Bug report
 description: Create a report to help us improve
 title: Good bug title tells us about precise symptom, not about the root cause.
-labels: [bug]
+labels: ['type: bug']
 body:
   - type: textarea
     id: description
@@ -48,14 +48,22 @@ body:
     attributes:
       label: Environment
       description: |
-        For older commitizen versions, please include the output of the following commands manually
-      placeholder: |
-        - commitizen version: `cz version`
-        - python version: `python --version`
-        - operating system: `python3 -c "import platform; print(platform.system())"`
+        Please use the following command to retrieve environment information
 
         ```bash
         cz version --report
         ```
+
+        If `cz version --report` is not available, please run the following commands to retrieve your environment information:
+
+        ```bash
+        echo "Commitizen Version: $(cz version)"
+        echo "Python Version: $(python3 -c 'import sys; print(sys.version)')"
+        echo "Operating System: $(python3 -c 'import platform; print(platform.system())')"
+        ```
+      placeholder: |
+        Commitizen Version: 4.0.0
+        Python Version: 3.13.3 (main, Apr  8 2025, 13:54:08) [Clang 16.0.0 (clang-1600.0.26.6)]
+        Operating System: Darwin
     validations:
       required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -3,4 +3,5 @@
 blank_issues_enabled: false
 contact_links:
   - name: Security Contact
+    url: https://github.com/woile
     about: Please report security vulnerabilities to santiwilly@gmail.com

.github/ISSUE_TEMPLATE/documentation.yml

@@ -1,7 +1,7 @@
 name: 📖 Documentation
 description: Suggest an improvement for the documentation of this project
 title: Content to be added or fixed
-labels: [documentation]
+labels: ['type: documentation']
 body:
   - type: checkboxes
     id: type

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,7 +1,7 @@
 name: 🚀 Feature request
 description: Suggest an idea for this project
 title: "<One feature request per issue>"
-labels: [feature]
+labels: ['type: feature']
 body:
   - type: textarea
     id: description
@@ -26,6 +26,6 @@ body:
   - type: textarea
     id: related-issue
     attributes:
-      label: Additional context
+      label: Related issues
       description: |
         If applicable, add link to existing issue also help us know better.

.github/pull_request_template.md

@@ -9,12 +9,31 @@ Please fill in the following content to let us know better about this change.
 
 ## Checklist
 
+- [ ] I have read the [contributing guidelines](https://commitizen-tools.github.io/commitizen/contributing/)
+
+### Code Changes
+
 - [ ] Add test cases to all the changes you introduce
-- [ ] Run `./scripts/format` and `./scripts/test` locally to ensure this change passes linter check and test
-- [ ] Test the changes on the local machine manually
+- [ ] Run `poetry all` locally to ensure this change passes linter check and tests
+- [ ] Manually test the changes:
+  - [ ] Verify the feature/bug fix works as expected in real-world scenarios
+  - [ ] Test edge cases and error conditions
+  - [ ] Ensure backward compatibility is maintained
+  - [ ] Document any manual testing steps performed
 - [ ] Update the documentation for the changes
 
-## Expected behavior
+### Documentation Changes
+
+- [ ] Run `poetry doc` locally to ensure the documentation pages renders correctly
+- [ ] Check and fix any broken links (internal or external) in the documentation
+
+> When running `poetry doc`, any broken internal documentation links will be reported in the console output like this:
+>
+> ```text
+> INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.
+> ```
+
+## Expected Behavior
 <!-- A clear and concise description of what you expected to happen -->
 
 
@@ -25,5 +44,5 @@ Please fill in the following content to let us know better about this change.
 3. ... -->
 
 
-## Additional context
+## Additional Context
 <!-- Add any other RELATED ISSUE, context or screenshots about the pull request here. -->

.github/workflows/bumpversion.yml

@@ -12,7 +12,7 @@ jobs:
     name: "Bump version and create changelog with commitizen"
     steps:
       - name: Check out
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0
           token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"

.github/workflows/docspublish.yml

@@ -4,27 +4,28 @@ on:
   push:
     branches:
       - master
+  workflow_dispatch:
 
 jobs:
   update-cli-screenshots:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
           fetch-depth: 0
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.x"
       - name: Install dependencies
         run: |
-          python -m pip install -U pip poetry
+          python -m pip install -U pip poetry poethepoet
           poetry --version
-          poetry install
+          poetry install --only main,script
       - name: Update CLI screenshots
         run: |
-          poetry run python scripts/gen_cli_help_screenshots.py
+          poetry doc:screenshots
       - name: Commit and push updated CLI screenshots
         run: |
           git config --global user.name "github-actions[bot]"
@@ -42,35 +43,35 @@ jobs:
     runs-on: ubuntu-latest
     needs: update-cli-screenshots
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         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
+        uses: actions/setup-python@v6
         with:
           python-version: "3.x"
       - name: Install dependencies
         run: |
-          python -m pip install -U mkdocs mkdocs-material
-      - name: Build docs
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          python -m mkdocs build
+          python -m pip install -U pip poetry poethepoet
+          poetry --version
+          poetry install --no-root --only documentation
       - name: Generate Sponsors 💖
         uses: JamesIves/github-sponsors-readme-action@v1
         with:
           token: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_ORG }}
           file: "docs/README.md"
-      - name: Push doc to Github Page
-        uses: peaceiris/actions-gh-pages@v4
+          organization: true
+      - name: Build docs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          poetry doc:build
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
-          personal_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
-          publish_branch: gh-pages
-          publish_dir: ./site
-          user_name: "github-actions[bot]"
-          user_email: "github-actions[bot]@users.noreply.github.com"
+          folder: ./site # The folder the action should deploy.
+          branch: gh-pages

.github/workflows/homebrewpublish.yml

@@ -12,9 +12,9 @@ jobs:
     if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.x"
       - name: Install dependencies
@@ -24,7 +24,7 @@ jobs:
         run: |
           echo "project_version=$(cz version --project)" >> $GITHUB_ENV
       - name: Update Homebrew formula
-        uses: dawidd6/action-homebrew-bump-formula@v4
+        uses: dawidd6/action-homebrew-bump-formula@v5
         with:
           token: ${{secrets.PERSONAL_ACCESS_TOKEN}}
           formula: commitizen

.github/workflows/label_issues.yml

@@ -12,12 +12,35 @@ jobs:
       issues: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/github-script@v7
+      - uses: actions/github-script@v8
         with:
           script: |
-            github.rest.issues.addLabels({
+            const issue = await github.rest.issues.get({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
-              labels: ['issue-status: needs-triage']
-            })
+            });
+
+            const body = issue.data.body || '';
+
+            const osLabels = new Set(); // Use a Set to avoid duplicates
+
+            // Parse the "Environment" section, output of `cz version --report`
+            if (body.includes('Operating System: Darwin')) {
+              osLabels.add('os: macOS');
+            }
+
+            if (body.includes('Operating System: Linux')) {
+              osLabels.add('os: Linux');
+            }
+
+            if (body.includes('Operating System: Windows')) {
+              osLabels.add('os: Windows');
+            }
+
+            await github.rest.issues.addLabels({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              labels: ['issue-status: needs-triage', ...osLabels],
+            });

.github/workflows/label_pr.yml

@@ -9,11 +9,39 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
       with:
         sparse-checkout: |
           .github/labeler.yml
         sparse-checkout-cone-mode: false
-    - uses: actions/labeler@v5
+    - uses: actions/labeler@v6
       with:
         configuration-path: .github/labeler.yml
+    - name: Label based on PR title
+      uses: actions/github-script@v8
+      with:
+        script: |
+          const title = context.payload.pull_request.title.toLowerCase();
+          const labels = [];
+
+          if (title.includes("fix") || title.includes("bug")) {
+            labels.push("type: bug");
+          }
+          if (title.includes("feat")) {
+            labels.push("type: feature");
+          }
+          if (title.includes("doc")) {
+            labels.push("type: documentation");
+          }
+          if (title.includes("refactor")) {
+            labels.push("type: refactor");
+          }
+
+          if (labels.length > 0) {
+            await github.rest.issues.addLabels({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              labels
+            });
+          }