feat: add additional_options input for GitHub Action (#477)

python-semantic-release · Jul 25, 2022 · aea60e3 · aea60e3
1 parent db5b425
commit aea60e3
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/action.sh b/action.sh
@@ -17,5 +17,8 @@ git config --global user.name "github-actions"
 git config --global user.email "action@github.com"
 
 # Run Semantic Release
-/semantic-release/.venv/bin/python -m semantic_release publish -v DEBUG \
-  -D commit_author="github-actions <action@github.com>"
+/semantic-release/.venv/bin/python \
+  -m semantic_release publish \
+  -v DEBUG \
+  -D commit_author="github-actions <action@github.com>" \
+  "${INPUT_ADDITIONAL_OPTIONS}"
diff --git a/docs/automatic-releases/github-actions.rst b/docs/automatic-releases/github-actions.rst
@@ -10,16 +10,18 @@ Inputs
 +--------------------------+----------------------------------------------------------------------------------------+
 | Input                    | Description                                                                            |
 +==========================+========================================================================================+
-| ``github_token``         | See :ref:`env-gh_token`. this is usually set to ``${{ secrets.GITHUB_TOKEN }}``. |
+| ``github_token``         | See :ref:`env-gh_token`. this is usually set to ``${{ secrets.GITHUB_TOKEN }}``.       |
 +--------------------------+----------------------------------------------------------------------------------------+
 | ``pypi_token``           | See :ref:`env-pypi_token`.                                                             |
 +--------------------------+----------------------------------------------------------------------------------------+
-| ``repository_username``  | See :ref:`env-repository_username`.                                                          |
+| ``repository_username``  | See :ref:`env-repository_username`.                                                    |
 +--------------------------+----------------------------------------------------------------------------------------+
-| ``repository_password``  | See :ref:`env-repository_password`.                                                          |
+| ``repository_password``  | See :ref:`env-repository_password`.                                                    |
 +--------------------------+----------------------------------------------------------------------------------------+
 | ``directory``            | A sub-directory to ``cd`` into before running. Defaults to the root of the repository. |
 +--------------------------+----------------------------------------------------------------------------------------+
+| ``additional_options``   | Additional :ref:`cmd-common-options` for the ``publish`` command. Example: ``--noop``  |
++--------------------------+----------------------------------------------------------------------------------------+
 
 Other options are taken from your regular configuration file.
 

diff --git a/docs/commands.rst b/docs/commands.rst
@@ -55,6 +55,8 @@ Publish will do a sequence of things:
 
 Some of these steps may be disabled based on your configuration.
 
+.. _cmd-common-options:
+
 Common Options
 ~~~~~~~~~~~~~~