Skip to content

Commit

Permalink
docs: clarify v8 breaking changes in GitHub action inputs (#643)
Browse files Browse the repository at this point in the history
  • Loading branch information
browniebroke committed Jul 18, 2023
1 parent 2129b72 commit cda050c
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/migrating_from_v7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,24 +113,24 @@ GitHub Action:

.. _breaking-github-action-removed-pypi-token:

Removal of ``pypi_token`` input
"""""""""""""""""""""""""""""""
The ``pypi_token`` input of the GitHub action has been removed. You should
supply the token as the value of the ``repository_username`` instead,
and if using only the token for authentication, remember to set the
``repository_username`` input equal to ``__token__``.
Removal of ``pypi_token``, ``repository_username`` and ``repository_password`` inputs
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

Since the library no longer supports publishing to PyPI, the ``pypi_token``,
``repository_username`` and ``repository_password`` inputs of the GitHub action have
all been removed. See the above section for how to publish to PyPI using the official
GitHub Action from the Python Packaging Authority (PyPA).

.. _breaking-options-inputs:

``additional_options``, ``version_options`` and ``publish_options``
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Rename ``additional_options`` to ``root_options``
"""""""""""""""""""""""""""""""""""""""""""""""""

Because the purposes of the :ref:`cmd-version` and :ref:`cmd-publish` commands
have changed, the GitHub action now performs both commands in sequence. For this
reason, and because the usage of the CLI has changed, ``additional_options`` can
now only supply flags to the main :ref:`cmd-main` command group, and two new inputs,
``version_options`` and ``publish_options``, have been added to supply the
required command-line options to the relevant commands in the GitHub Action.
reason, and because the usage of the CLI has changed, ``additional_options`` has
been renamed to ``root_options`` to reflect the fact that the options are for the
main :ref:`cmd-main` command group.

.. _breaking-commands:

Expand Down

0 comments on commit cda050c

Please sign in to comment.