Skip to content

Commit

Permalink
docs: add common options to documentation
Browse files Browse the repository at this point in the history
These can be found by running `semantic-release --help`, but including them
in the documentation will be helpful for CI users who don't have the command
installed locally.

Related to #327.
  • Loading branch information
danth committed Feb 19, 2021
1 parent 77dcf05 commit 20d79a5
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions docs/commands.rst
Expand Up @@ -53,3 +53,44 @@ Publish will do a sequence of things:
#. Attach the files created by :ref:`config-build_command` to GitHub releases.

Some of these steps may be disabled based on your configuration.

Common Options
~~~~~~~~~~~~~~

Every command understands these flags:

``--patch``
...........

Force a patch release, ignoring the version bump determined from commit messages.

``--minor``
...........

Force a minor release, ignoring the version bump determined from commit messages.

``--major``
...........

Force a major release, ignoring the version bump determined from commit messages.

``--noop``
..........

No operations mode. Do not take any actions, only print what will be done.

``--retry``
...........

Retry the same release, do not bump.

``--define``
............

Override a configuration value. Takes an argument of the format
``setting="value"``.

``--verbosity``
...............

Change the verbosity of Python Semantic Release's logging. See :ref:`debug-usage`.

0 comments on commit 20d79a5

Please sign in to comment.