python-semantic-release 9.9.0__tar.gz → 9.10.1__tar.gz

{python_semantic_release-9.9.0/python_semantic_release.egg-info → python_semantic_release-9.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-semantic-release
-Version: 9.9.0
+Version: 9.10.1
 Summary: Automatic Semantic Versioning for Python projects
 Author-email: Rolf Erik Lekang <me@rolflekang.com>
 License: MIT

{python_semantic_release-9.9.0 → python_semantic_release-9.10.1}/docs/automatic-releases/github-actions.rst

@@ -68,6 +68,31 @@ outlines each supported input and its purpose.
 
 ----
 
+.. _gh_actions-psr-inputs-build:
+
+``build``
+""""""""
+
+**Type:** ``Literal["true", "false"]``
+
+Override whether the action should execute the build command or not. This option is
+equivalent to adding the command line switch ``--skip-build`` (when ``false``) to
+the :ref:`version <cmd-version>` command. If set to ``true``, no command line switch
+is passed and the default behavior of the :ref:`version <cmd-version>` is used.
+
+**Required:** ``false``
+
+.. note::
+  If not set or set to ``true``, the default behavior is defined by the
+  :ref:`version <cmd-version>` command and any user :ref:`configurations <config-root>`.
+
+.. seealso::
+
+  - :ref:`cmd-version-option-skip_build` option for the :ref:`version <cmd-version>`
+    command.
+
+----
+
 .. _gh_actions-psr-inputs-build_metadata:
 
 ``build_metadata``
@@ -312,7 +337,7 @@ before the :ref:`version <cmd-version>` subcommand.
 
   .. code:: yaml
 
-    - uses: python-semantic-release/python-semantic-release@v9.9.0
+    - uses: python-semantic-release/python-semantic-release@v9.10.1
       with:
         root_options: "-vv --noop"
 
@@ -643,14 +668,23 @@ to the GitHub Release Assets as well.
           contents: write
 
         steps:
-          - uses: actions/checkout@v4
+          # Note: we need to checkout the repository at the workflow sha in case during the workflow
+          # the branch was updated. To keep PSR working with the configured release branches,
+          # we force a checkout of the desired release branch but at the workflow sha HEAD.
+          - name: Setup | Checkout Repository at workflow sha
+            uses: actions/checkout@v4
             with:
               fetch-depth: 0
+              ref: ${{ github.sha }}
+
+          - name: Setup | Force correct release branch on workflow sha
+            run: |
+              git checkout -B ${{ github.ref_name }} ${{ github.sha }}
 
           - name: Action | Semantic Version Release
             id: release
             # Adjust tag with desired version if applicable.
-            uses: python-semantic-release/python-semantic-release@v9.9.0
+            uses: python-semantic-release/python-semantic-release@v9.10.1
             with:
               github_token: ${{ secrets.GITHUB_TOKEN }}
               git_committer_name: "github-actions"
@@ -710,7 +744,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@v9.9.0
+    uses: python-semantic-release/python-semantic-release@v9.10.1
     with:
       github_token: ${{ secrets.GITHUB_TOKEN }}
       force: patch
@@ -738,13 +772,13 @@ Publish Action.
 .. code:: yaml
 
    - name: Release Project 1
-     uses: python-semantic-release/python-semantic-release@v9.9.0
+     uses: python-semantic-release/python-semantic-release@v9.10.1
      with:
        directory: ./project1
        github_token: ${{ secrets.GITHUB_TOKEN }}
 
    - name: Release Project 2
-     uses: python-semantic-release/python-semantic-release@v9.9.0
+     uses: python-semantic-release/python-semantic-release@v9.10.1
      with:
        directory: ./project2
        github_token: ${{ secrets.GITHUB_TOKEN }}