From 66f579f526571af09b284c5f32b777c12dbb3f64 Mon Sep 17 00:00:00 2001
From: Bart Dorlandt <bart@bamweb.nl>
Date: Thu, 5 Jun 2025 15:48:39 +0200
Subject: [PATCH] docs(github-actions): clarify with examples of the
 `root_options` v10 migration change

---
 .../automatic-releases/github-actions.rst     | 16 +++----
 docs/upgrading/10-upgrade.rst                 | 47 ++++++++++++++++---
 2 files changed, 48 insertions(+), 15 deletions(-)

diff --git a/docs/configuration/automatic-releases/github-actions.rst b/docs/configuration/automatic-releases/github-actions.rst
index 4fc5022af..93024e3dd 100644
--- a/docs/configuration/automatic-releases/github-actions.rst
+++ b/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.2
+    - 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.2
+    - uses: python-semantic-release/publish-action@v9
       with:
         root_options: "-vv --noop"
 
diff --git a/docs/upgrading/10-upgrade.rst b/docs/upgrading/10-upgrade.rst
index ffd6b0276..7cb4e03be 100644
--- a/docs/upgrading/10-upgrade.rst
+++ b/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:

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/python-semantic-release/python-semantic-release/pull/1271.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/python-semantic-release/python-semantic-release/pull/1271.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/python-semantic-release/python-semantic-release/pull/1271.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/python-semantic-release/python-semantic-release/pull/1271.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>