python-semantic-release 10.0.1__tar.gz → 10.1.0__tar.gz

{python_semantic_release-10.0.1 → python_semantic_release-10.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-semantic-release
-Version: 10.0.1
+Version: 10.1.0
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT
@@ -25,7 +25,7 @@ Requires-Dist: click-option-group~=0.5
 Requires-Dist: gitpython~=3.0
 Requires-Dist: requests~=2.25
 Requires-Dist: jinja2~=3.1
-Requires-Dist: python-gitlab<6.0.0,>=4.0.0
+Requires-Dist: python-gitlab<7.0.0,>=4.0.0
 Requires-Dist: tomlkit~=0.11
 Requires-Dist: dotty-dict~=1.3
 Requires-Dist: importlib-resources~=6.0
@@ -62,7 +62,7 @@ Requires-Dist: pre-commit~=3.5; extra == "dev"
 Requires-Dist: tox~=4.11; extra == "dev"
 Requires-Dist: ruff==0.6.1; extra == "dev"
 Provides-Extra: mypy
-Requires-Dist: mypy==1.15.0; extra == "mypy"
+Requires-Dist: mypy==1.16.0; extra == "mypy"
 Requires-Dist: types-Deprecated~=1.2; extra == "mypy"
 Requires-Dist: types-requests~=2.32.0; extra == "mypy"
 Requires-Dist: types-pyyaml~=6.0; extra == "mypy"

{python_semantic_release-10.0.1 → python_semantic_release-10.1.0}/docs/api/commands.rst

@@ -96,25 +96,73 @@ pipeline, while omitting this flag would allow the pipeline to continue to run.
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Detect the semantically correct next version that should be applied to your
-project.
+project and release it.
 
-By default:
+By default (in order):
 
-  * Write this new version to the project metadata locations
-    specified in the configuration file
-  * Build the project using :ref:`config-build_command`, if specified
-  * Create a new commit with these locations and any other assets configured
-    to be included in a release
-  * Tag this commit according the configured format, with a tag that uniquely
-    identifies the version being released
-  * Push the new tag and commit to the remote for the repository
-  * Create a release (if supported) in the remote VCS for this tag
+  #.  Write this new version to the project metadata locations
+      specified in the configuration file
+
+  #.  Update the changelog file with the new version and any changes
+      introduced since the last release, using the configured changelog template
+
+  #.  Build the project using :ref:`config-build_command`, if specified
+
+  #.  Create a new commit with these locations and any other assets configured
+      to be included in a release
+
+  #.  Tag this commit according the configured format, with a tag that uniquely
+      identifies the version being released
+
+  #.  Push the new tag and commit to the remote for the repository
+
+  #.  Create a release in the remote VCS for this tag (if supported)
+
+All of these steps can be toggled on or off using the command line options
+described below. Some of the steps rely on others, so some options may implicitly
+disable others.
 
 Changelog generation is done identically to the way it is done in :ref:`cmd-changelog`,
 but this command additionally ensures the updated changelog is included in the release
 commit that is made.
 
+  **Common Variations**
+
+  .. code-block:: bash
+
+    # Print the next version that will be applied
+    semantic-release version --print
+
+    # Print the next version that will be applied, including the tag prefix
+    semantic-release version --print-tag
+
+    # Print the last released version
+    semantic-release version --print-last-released
+
+    # Print the last released version, including the tag prefix
+    semantic-release version --print-last-released-tag
+
+    # Only stamp the next version in the project metadata locations
+    semantic-release version --no-changelog --skip-build --no-commit --no-tag
+
+    # Stamp the version, update the changelog, and run the build command, then stop
+    semantic-release version --no-commit --no-tag
+
+    # Make all local changes but do not publish them to the remote (changelog, build, commit & tag)
+    semantic-release version --no-push
+
+    # Don't ever create a changelog (but do everything else)
+    semantic-release version --no-changelog
+
+    # Don't create a release in the remote VCS (but do publish the commit and tag)
+    semantic-release version --no-vcs-release
+
+    # Do everything
+    semantic-release version
+
+
 .. seealso::
+    - :ref:`Ultraviolet (uv) integration <config-guides-uv_integration>`
     - :ref:`cmd-changelog`
     - :ref:`changelog-templates`
     - :ref:`config-tag_format`
@@ -122,6 +170,7 @@ commit that is made.
     - :ref:`config-version_toml`
     - :ref:`config-version_variables`
 
+
 .. _cmd-version-options:
 
 Options:
@@ -362,9 +411,9 @@ Whether or not to push new commits and/or tags to the remote repository.
 ``--vcs-release/--no-vcs-release``
 **********************************
 
-Whether or not to create a "release" in the remote VCS service, if supported. Currently
-releases in GitHub and Gitea remotes are supported. If releases aren't supported in a
-remote VCS, this option will not cause a command failure, but will produce a warning.
+Whether or not to create a "release" in the remote VCS service, if supported. If
+releases aren't supported in a remote VCS, this option will not cause a command
+failure, but will produce a warning.
 
 **Default:** ``--no-vcs-release`` if ``--no-push`` is supplied (including where this is
 implied by supplying only ``--no-commit``), otherwise ``--vcs-release``

{python_semantic_release-10.0.1 → python_semantic_release-10.1.0}/docs/configuration/automatic-releases/github-actions.rst

@@ -371,9 +371,9 @@ to the remote repository. This option is equivalent to adding either ``--push``
 """"""""""""""""
 
 .. important::
-  This option has been removed in v10.0.0 and newer because of a
-  command injection vulnerability. Please update as to v10.0.0 as soon
-  as possible.
+  This option has been removed in v10.0.0 and newer because of a command injection
+  vulnerability. Please update as to v10.0.0 as soon as possible. See
+  :ref:`Upgrading to v10 <upgrade_v10-root_options>` for more information.
 
 Additional options for the main ``semantic-release`` command, which will come
 before the :ref:`version <cmd-version>` subcommand.
@@ -382,7 +382,7 @@ before the :ref:`version <cmd-version>` subcommand.
 
   .. code:: yaml
 
-    - uses: python-semantic-release/python-semantic-release@v10.0.0
+    - uses: python-semantic-release/python-semantic-release@v9
       with:
         root_options: "-vv --noop"
 
@@ -688,9 +688,9 @@ This is useful for testing the action without actually publishing anything.
 """"""""""""""""
 
 .. important::
-  This option has been removed in v10.0.0 and newer because of a
-  command injection vulnerability. Please update as to v10.0.0 as soon
-  as possible.
+  This option has been removed in v10.0.0 and newer because of a command injection
+  vulnerability. Please update as to v10.0.0 as soon as possible. See
+  :ref:`Upgrading to v10 <upgrade_v10-root_options>` for more information.
 
 Additional options for the main ``semantic-release`` command, which will come
 before the :ref:`publish <cmd-publish>` subcommand.
@@ -699,7 +699,7 @@ before the :ref:`publish <cmd-publish>` subcommand.
 
   .. code:: yaml
 
-    - uses: python-semantic-release/publish-action@v10.0.0
+    - uses: python-semantic-release/publish-action@v9
       with:
         root_options: "-vv --noop"
 
@@ -873,14 +873,14 @@ to the GitHub Release Assets as well.
           - name: Action | Semantic Version Release
             id: release
             # Adjust tag with desired version if applicable.
-            uses: python-semantic-release/python-semantic-release@v10.0.0
+            uses: python-semantic-release/python-semantic-release@v10.1.0
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
               git_committer_name: "github-actions"
               git_committer_email: "actions@users.noreply.github.com"
 
           - name: Publish | Upload to GitHub Release Assets
-            uses: python-semantic-release/publish-action@v10.0.0
+            uses: python-semantic-release/publish-action@v10.1.0
             if: steps.release.outputs.released == 'true'
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -979,7 +979,7 @@ The equivalent GitHub Action configuration would be:
 
   - name: Action | Semantic Version Release
     # Adjust tag with desired version if applicable.
-    uses: python-semantic-release/python-semantic-release@v10.0.0
+    uses: python-semantic-release/python-semantic-release@v10.1.0
     with:
       github_token: ${{ secrets.GITHUB_TOKEN }}
       force: patch
@@ -1038,14 +1038,14 @@ Publish Action.
 
         - name: Release submodule 1
           id: release-submod-1
-          uses: python-semantic-release/python-semantic-release@v10.0.0
+          uses: python-semantic-release/python-semantic-release@v10.1.0
           with:
             directory: ${{ env.SUBMODULE_1_DIR }}
             github_token: ${{ secrets.GITHUB_TOKEN }}
 
         - name: Release submodule 2
           id: release-submod-2
-          uses: python-semantic-release/python-semantic-release@v10.0.0
+          uses: python-semantic-release/python-semantic-release@v10.1.0
           with:
             directory: ${{ env.SUBMODULE_2_DIR }}
             github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -1057,7 +1057,7 @@ Publish Action.
         # ------------------------------------------------------------------- #
 
         - name: Publish | Upload package 1 to GitHub Release Assets
-          uses: python-semantic-release/publish-action@v10.0.0
+          uses: python-semantic-release/publish-action@v10.1.0
           if: steps.release-submod-1.outputs.released == 'true'
           with:
             directory: ${{ env.SUBMODULE_1_DIR }}
@@ -1065,7 +1065,7 @@ Publish Action.
             tag: ${{ steps.release-submod-1.outputs.tag }}
 
         - name: Publish | Upload package 2 to GitHub Release Assets
-          uses: python-semantic-release/publish-action@v10.0.0
+          uses: python-semantic-release/publish-action@v10.1.0
           if: steps.release-submod-2.outputs.released == 'true'
           with:
             directory: ${{ env.SUBMODULE_2_DIR }}

python_semantic_release-10.1.0/docs/configuration/configuration-guides/index.rst

@@ -0,0 +1,14 @@
+.. _config-guides:
+
+Configuration Guides
+====================
+
+This section provides detailed guides on how to configure PSR for various use cases and
+integrations. It is recommended to complete the
+:ref:`Getting Started Guide <getting-started-guide>` first before diving into these
+more specific configurations.
+
+.. toctree::
+    :maxdepth: 1
+
+    UV Project Setup <uv_integration>

python_semantic_release-10.1.0/docs/configuration/configuration-guides/uv_integration.rst

@@ -0,0 +1,327 @@
+.. _config-guides-uv_integration:
+
+Ultraviolet (``uv``) Integration
+================================
+
+.. _uv: https://docs.astral.sh/uv/
+
+`uv`_ is an extremely fast Python package and project manager that
+provides a modern alternative to `pip <https://pip.pypa.io/en/stable/>`_
+and `venv <https://docs.python.org/3/library/venv.html>`_. It provides a lot
+of features that solve the common problems of Python package management but
+it also introduces a few quirks that need to be taken into account when using
+Python Semantic Release.
+
+.. important::
+
+  **Prerequisite:** Make sure you have run through the
+  :ref:`Getting Started Guide <getting-started-guide>` before proceeding with
+  this guide.
+
+
+Updating the ``uv.lock``
+------------------------
+
+One of the best features of ``uv`` is that it automatically generates a lock file
+(``uv.lock``) that contains the exact versions of all the dependencies used in
+your project. The lock file is generated when you run the ``uv install`` command,
+and it is used to ensure that CI workflows are repeatable and development environments
+are consistent.
+
+When creating a new release using Python Semantic Release, PSR will update the version
+in the project's definition file (e.g., ``pyproject.toml``) to indicate the new version.
+Unfortunately, this action will cause ``uv`` to fail on the next execution because the
+lock file will be out of sync with the project's definition file. There are two ways to
+resolve this issue depending on your preference:
+
+#.  **Add a step to your build command**: Modify your
+    :ref:`semantic_release.build_command <config-build_command>` to include the command
+    to update the lock file and stage it for commit.  This is commonly used with the
+    :ref:`GitHub Action <gh_actions-psr>` and other CI/CD tools when you are building
+    the artifact at the time of release.
+
+    .. code-block:: toml
+
+      [tool.semantic_release]
+      build_command = """
+        uv lock --offline
+        git add uv.lock
+        uv build
+      """
+
+    The ``--offline`` flag is used to ensure that the lock file is updated without
+    updating any dependency versions. The intent of this call is **ONLY** to update
+    the version of your project within the lock file after PSR has updated the version
+    in your project's definition file (e.g., ``pyproject.toml``). When you are running
+    PSR, you have already tested the project as is and you don't want to actually
+    update the dependencies if a new one just became available.
+
+    If you are using the :ref:`PSR GitHub Action <gh_actions-psr>`, you will need to add an
+    installation command for ``uv`` to the :ref:`build_command <config-build_command>`
+    because the action runs in a Docker environment does not include ``uv`` by default.
+    The best way to ensure that the correct version of ``uv`` is installed is to define
+    the version of ``uv`` in an optional dependency list (e.g. ``build``). This will
+    also help with other automated tools like Dependabot or Renovate to keep the version
+    of ``uv`` up to date.
+
+    .. code-block:: toml
+
+      [project.optional-dependencies]
+      build = ["uv ~= 0.7.12"]
+
+      [tool.semantic_release]
+      build_command = """
+        python -m pip install -e .[build]
+        uv lock --offline
+        git add uv.lock
+        uv build
+      """
+
+#.  **Stamp the code first & then separately run release**: If you prefer to not modify the
+    build command, then you will need to run the ``uv lock --offline`` command prior to actually
+    creating the release. Essentially, you will run PSR twice: (1) once to update the version
+    in the project's definition file, and (2) a second time to generate the release.
+
+    The intent of the ``uv lock --offline`` command is **ONLY** to update the version of your
+    project within the lock file after PSR has updated the version in your project's definition
+    file (e.g., ``pyproject.toml``). When you are running PSR, you have already tested the project
+    as is and you don't want to actually update the dependencies if a new one just became available.
+
+    .. code-block:: bash
+
+      # 1. PSR stamps version into files (nothing else)
+      # don't build the changelog (especially in update mode)
+      semantic-release -v version --skip-build --no-commit --no-tag --no-changelog
+
+      # 2. run UV lock as pyproject.toml is updated with the next version
+      uv lock --offline
+
+      # 3. stage the lock file to ensure it is included in the PSR commit
+      git add uv.lock
+
+      # 4. run PSR fully to create release
+      semantic-release -v version
+
+**Advanced Example**
+
+Of course, you can mix and match these 2 approaches as needed. If PSR's pipeline was using
+``uv``, we would have a mixture of the 2 approaches because we run the build in a separate
+job from the release. In our case, PSR would also need to carry the lock file as a workflow
+artifact along the pipeline for the release job to commit it. This advanced workflow would
+look like this:
+
+.. code-block:: text
+
+  # File: .tool-versions
+  uv 0.7.12
+
+.. code-block:: text
+
+  # File: .python-version
+  3.11.11
+
+.. code-block:: toml
+
+  # File: pyproject.toml
+  [project.optional-dependencies]
+  build = ["python-semantic-release ~= 10.0"]
+  test = ["pytest ~= 8.0"]
+
+  [tool.semantic_release]
+  build_command = """
+    uv lock --offline
+    uv build
+  """
+
+.. code-block:: yaml
+
+  # File: .github/workflows/release.yml
+  on:
+    push:
+      branches:
+        - main
+
+  jobs:
+
+    build:
+      runs-on: ubuntu-latest
+      permissions:
+        contents: read
+      env:
+        dist_artifacts_name: dist
+        dist_artifacts_dir: dist
+        lock_file_artifact: uv.lock
+      steps:
+        - name: Setup | Checkout Repository at workflow sha
+          uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+          with:
+            ref: ${{ github.sha }}
+            fetch-depth: 0
+
+        - name: Setup | Force correct release branch on workflow sha
+          run: git checkout -B ${{ github.ref_name }}
+
+        - name: Setup | Install uv
+          uses: asdf-vm/actions/install@1902764435ca0dd2f3388eea723a4f92a4eb8302  # v4.0.2
+
+        - name: Setup | Install Python & Project dependencies
+          run: uv sync --extra build
+
+        - name: Build | Build next version artifacts
+          id: version
+          env:
+            GH_TOKEN: "none"
+          run: uv run semantic-release -v version --no-commit --no-tag
+
+        - name: Upload | Distribution Artifacts
+          if: ${{ steps.version.outputs.released == 'true' }}
+          uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02  # v4.6.2
+          with:
+            name: ${{ env.dist_artifacts_name }}
+            path: ${{ format('{0}/**', env.dist_artifacts_dir) }}
+            if-no-files-found: error
+            retention-days: 2
+
+        - name: Upload | Lock File Artifact
+          if: ${{ steps.version.outputs.released == 'true' }}
+          uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02  # v4.6.2
+          with:
+            name: ${{ env.lock_file_artifact }}
+            path: ${{ env.lock_file_artifact }}
+            if-no-files-found: error
+            retention-days: 2
+
+      outputs:
+        new-release-detected: ${{ steps.version.outputs.released }}
+        new-release-version: ${{ steps.version.outputs.version }}
+        new-release-tag: ${{ steps.version.outputs.tag }}
+        new-release-is-prerelease: ${{ steps.version.outputs.is_prerelease }}
+        distribution-artifacts: ${{ env.dist_artifacts_name }}
+        lock-file-artifact: ${{ env.lock_file_artifact }}
+
+
+    test-e2e:
+      needs: build
+      runs-on: ubuntu-latest
+      steps:
+        - name: Setup | Checkout Repository
+          uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+          with:
+            ref: ${{ github.sha }}
+            fetch-depth: 1
+
+        - name: Setup | Download Distribution Artifacts
+          uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093  # v4.3.0
+          if: ${{ needs.build.outputs.new-release-detected == 'true' }}
+          id: artifact-download
+          with:
+            name: ${{ needs.build.outputs.distribution-artifacts }}
+            path: ./dist
+
+        - name: Setup | Install uv
+          uses: asdf-vm/actions/install@1902764435ca0dd2f3388eea723a4f92a4eb8302  # v4.0.2
+
+        - name: Setup | Install Python & Project dependencies
+          run: uv sync --extra test
+
+        - name: Setup | Install distribution artifact
+          if: ${{ steps.artifact-download.outcome == 'success' }}
+          run: |
+            uv pip uninstall my-package
+            uv pip install dist/python_semantic_release-*.whl
+
+        - name: Test | Run pytest
+          run: uv run pytest -vv tests/e2e
+
+
+    release:
+      runs-on: ubuntu-latest
+      needs:
+        - build
+        - test-e2e
+
+      if: ${{ needs.build.outputs.new-release-detected == 'true' }}
+
+      concurrency:
+        group: ${{ github.workflow }}-release-${{ github.ref_name }}
+        cancel-in-progress: false
+
+      permissions:
+        contents: write
+
+      steps:
+        - name: Setup | Checkout Repository on Release Branch
+          uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+          with:
+            ref: ${{ github.ref_name }}
+            fetch-depth: 0
+
+        - name: Setup | Force release branch to be at workflow sha
+          run: git reset --hard ${{ github.sha }}
+
+        - name: Setup | Install uv
+          uses: asdf-vm/actions/install@1902764435ca0dd2f3388eea723a4f92a4eb8302  # v4.0.2
+
+        - name: Setup | Install Python & Project dependencies
+          run: uv sync --extra build
+
+        - name: Setup | Download Build Artifacts
+          uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093  # v4.3.0
+          id: artifact-download
+          with:
+            name: ${{ needs.build.outputs.distribution-artifacts }}
+            path: dist
+
+        - name: Setup | Download Lock File Artifact
+          uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093  # v4.3.0
+          with:
+            name: ${{ needs.build.outputs.lock-file-artifact }}
+
+        - name: Setup | Stage Lock File for Version Commit
+          run: git add uv.lock
+
+        - name: Release | Create Release
+          id: release
+          shell: bash
+          env:
+            GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          run: |
+            bash .github/workflows/verify_upstream.sh
+            uv run semantic-release -v --strict version --skip-build
+            uv run semantic-release publish
+
+      outputs:
+        released: ${{ steps.release.outputs.released }}
+        new-release-version: ${{ steps.release.outputs.version }}
+        new-release-tag: ${{ steps.release.outputs.tag }}
+
+
+    deploy:
+      name: Deploy
+      runs-on: ubuntu-latest
+      if: ${{ needs.release.outputs.released == 'true' && github.repository == 'python-semantic-release/my-package' }}
+      needs:
+        - build
+        - release
+
+      environment:
+        name: pypi
+        url: https://pypi.org/project/my-package/
+
+      permissions:
+        id-token: write
+
+      steps:
+        - name: Setup | Download Build Artifacts
+          uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093  # v4.3.0
+          id: artifact-download
+          with:
+            name: ${{ needs.build.outputs.distribution-artifacts }}
+            path: dist
+
+        - name: Publish package distributions to PyPI
+          uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc  # v1.12.4
+          with:
+            packages-dir: dist
+            print-hash: true
+            verbose: true

python_semantic_release-10.1.0/docs/configuration/index.rst

@@ -0,0 +1,24 @@
+.. _configuration:
+
+Configuration
+=============
+
+Python Semantic Release is highly configurable, allowing you to tailor it to your
+project's needs. It supports various runtime environments and can be integrated with
+different CI/CD services.
+
+#.  Check out our set of :ref:`configuration guides <config-guides>` to help walk
+    you through the set up of common project customizations.
+
+#.  Dive in deep and explore the full set of possible :ref:`customization options <config>`.
+
+#.  Go Automatic and Configure your :ref:`CI/CD services <automatic>` to use Python
+    Semantic Release.
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    Guides <configuration-guides/index>
+    Options <configuration>
+    automatic-releases/index

{python_semantic_release-10.0.1 → python_semantic_release-10.1.0}/docs/upgrading/10-upgrade.rst

@@ -42,18 +42,51 @@ This vulnerability existed in both the
 
 For the main :ref:`python-semantic-release/python-semantic-release <gh_actions-psr>` action,
 the following inputs are now available (in place of the old ``root_options`` parameter):
+:ref:`gh_actions-psr-inputs-config_file`, :ref:`gh_actions-psr-inputs-noop`,
+:ref:`gh_actions-psr-inputs-strict`, and :ref:`gh_actions-psr-inputs-verbosity`.
 
-- :ref:`gh_actions-psr-inputs-config_file`
-- :ref:`gh_actions-psr-inputs-noop`
-- :ref:`gh_actions-psr-inputs-strict`
-- :ref:`gh_actions-psr-inputs-verbosity`
+  **Example migration**
+
+  If you previously had the following in your GitHub Actions workflow file:
+
+  .. code:: yaml
+
+    - uses: python-semantic-release/python-semantic-release@v9
+      with:
+        root_options: "-vv --strict"
+
+  It would be updated to:
+
+  .. code:: yaml
+
+    - uses: python-semantic-release/python-semantic-release@v10
+      with:
+        strict: true
+        verbosity: 2
 
 For the :ref:`python-semantic-release/publish-action <gh_actions-publish>` action,
 the following inputs are now available (in place of the old ``root_options`` parameter):
+:ref:`gh_actions-publish-inputs-config_file`, :ref:`gh_actions-publish-inputs-noop`,
+and :ref:`gh_actions-publish-inputs-verbosity`.
+
+  **Example migration**
+
+  If you previously had the following in your GitHub Actions workflow file:
+
+  .. code:: yaml
+
+    - uses: python-semantic-release/publish-action@v9
+      with:
+        root_options: "-v -c /path/to/releaserc.yaml"
+
+  It would be updated to:
+
+  .. code:: yaml
 
-- :ref:`gh_actions-publish-inputs-config_file`
-- :ref:`gh_actions-publish-inputs-noop`
-- :ref:`gh_actions-publish-inputs-verbosity`
+    - uses: python-semantic-release/publish-action@v10
+      with:
+        config_file: /path/to/releaserc.yaml
+        verbosity: 1
 
 
 .. _upgrade_v10-changelog_format-1_line_commit_subjects: