python-semantic-release · codejedi365 · May 25, 2025 · May 17, 2025 · Dec 20, 2024 · Dec 20, 2024
diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
@@ -180,6 +180,8 @@ jobs:
 
       - name: Test | Run pytest -m unit --comprehensive
         id: tests
+        env:
+          COLUMNS: 150
         run: |
           pytest                        \
             -vv                         \
@@ -248,6 +250,8 @@ jobs:
 
       - name: Test | Run pytest -m e2e --comprehensive
         id: tests
+        env:
+          COLUMNS: 150
         run: |
           pytest                                                   \
             -vv                                                    \
@@ -340,12 +344,15 @@ jobs:
       - name: Test | Run pytest -m e2e
         id: tests
         shell: pwsh
+
         # env:
           # Required for GitPython to work on Windows because of getpass.getuser()
           # USERNAME: "runneradmin"
+          # COLUMNS: 150
           # Because GHA is currently broken on Windows to pass these varables, we do it manually
         run: |
           $env:USERNAME = "runneradmin"
+          $env:COLUMNS = 150
           pytest                                                    `
             -vv                                                     `
             -nauto                                                  `

diff --git a/.gitignore b/.gitignore
@@ -61,7 +61,7 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
-docs/api/
+docs/api/modules/
 
 # PyBuilder
 target/

diff --git a/AUTHORS.rst b/AUTHORS.rst
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2310,7 +2310,7 @@ v8.0.0 (2023-07-16)
 💥 BREAKING CHANGES
 --------------------
 
-* numerous breaking changes, see :ref:`migrating-from-v7` for more information
+* numerous breaking changes, see :ref:`upgrade_v8` for more information
 
 .. _ec30564: https://github.com/python-semantic-release/python-semantic-release/commit/ec30564b4ec732c001d76d3c09ba033066d2b6fe
 .. _PR#619: https://github.com/python-semantic-release/python-semantic-release/pull/619

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -1,3 +1,5 @@
+.. _contributing_guide:
+
 Contributing
 ------------
 
@@ -7,7 +9,7 @@ Please remember to write tests for the cool things you create or fix.
 
 Unsure about something? No worries, `open an issue`_.
 
-.. _open an issue: https://github.com/relekang/python-semantic-release/issues/new
+.. _open an issue: https://github.com/python-semantic-release/python-semantic-release/issues/new
 
 Commit messages
 ~~~~~~~~~~~~~~~

diff --git a/docs/algorithm.rst b/docs/algorithm.rst
diff --git a/docs/commands.rst → docs/api/commands.rst b/docs/commands.rst → docs/api/commands.rst
@@ -1,7 +1,7 @@
 .. _commands:
 
-Commands
-========
+Command Line Interface (CLI)
+============================
 
 All commands accept a ``-h/--help`` option, which displays the help text for the
 command and exits immediately.
@@ -23,10 +23,11 @@ Correct::
    semantic-release -vv --noop version --print
 
 With the exception of :ref:`cmd-main` and :ref:`cmd-generate-config`, all
-commands require that you have set up your project's configuration. To help with
-this step, :ref:`cmd-generate-config` can create the default configuration for you,
-which will allow you to tweak it to your needs rather than write it from scratch.
+commands require that you have set up your project's configuration.
 
+To help with setting up your project configuration, :ref:`cmd-generate-config`
+will print out the default configuration to the console, which
+you can then modify it to match your project & environment.
 
 .. _cmd-main:
 

diff --git a/docs/changelog_templates.rst → docs/concepts/changelog_templates.rst b/docs/changelog_templates.rst → docs/concepts/changelog_templates.rst
@@ -248,7 +248,7 @@ Configuration Examples
 
 If identified or supported by the parser, the default changelog templates will include
 a separate section of breaking changes and additional release information. Refer to the
-:ref:`commit parsing <commit-parsing>` section to see how to write commit messages that
+:ref:`commit parsing <commit_parsing>` section to see how to write commit messages that
 will be properly parsed and displayed in these sections.
 
 
@@ -331,7 +331,7 @@ be copied to its target location without being rendered by the template engine.
     When initially starting out at customizing your own changelog templates, you
     should reference the default template embedded within PSR. The template directory
     is located at ``data/templates/`` within the PSR package. Within our templates
-    directory we separate out each type of commit parser (e.g. angular) and the
+    directory we separate out each type of commit parser (e.g. conventional) and the
     content format type (e.g. markdown). You can copy this directory to your
     repository's templates directory and then customize the templates to your liking.
 

diff --git a/docs/commit_parsing.rst → docs/concepts/commit_parsing.rst b/docs/commit_parsing.rst → docs/concepts/commit_parsing.rst
@@ -1,4 +1,4 @@
-.. _commit-parsing:
+.. _commit_parsing:
 
 Commit Parsing
 ==============
@@ -294,6 +294,11 @@ Guidelines`_ with all different commit types. Because of this small variance, th
 only extends our :ref:`commit_parser-builtin-angular` parser with pre-defined scipy commit types
 in the default Scipy Parser Options and all other features are inherited.
 
+**Limitations**:
+
+- Commits with the ``REV`` type are not currently supported. Track the implementation
+  of this feature in the issue `#402`_.
+
 If no commit parser options are provided via the configuration, the parser will use PSR's
 built-in :py:class:`defaults <semantic_release.commit_parser.scipy.ScipyParserOptions>`.
 
@@ -636,7 +641,7 @@ should inherit from the
 The "options" class is used to validate the options which are configured in the repository,
 and to provide default values for these options where appropriate.
 
-.. _commit-parsing-commit-parsers:
+.. _commit_parsing-commit-parsers:
 
 Commit Parsers
 """"""""""""""