Skip to content

Fix(doc) alternatives to root_options #1271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 7, 2025
Merged

Fix(doc) alternatives to root_options #1271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/configuration/automatic-releases/github-actions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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"

Expand Down Expand Up @@ -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.
Expand All @@ -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"

Expand Down
47 changes: 40 additions & 7 deletions docs/upgrading/10-upgrade.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down