diff --git a/docs/release.rst b/docs/release.rst index 2cc895f7..b4267465 100644 --- a/docs/release.rst +++ b/docs/release.rst @@ -16,7 +16,7 @@ Releasing Klein #. Commit and push the branch #. Open a PR from the branch (follow the usual process for opening a PR). #. As appropriate, pull the latest code from :code:`trunk`: :code:`git checkout trunk && git pull --rebase` (or use the GitHub UI) -#. To publish a release candidate to PyPI: :code:`tox -e release -- publish` +#. To publish a release candidate to PyPI: :code:`tox -e release -- publish --candidate` #. Obtain an approving review for the PR using the usual process. #. To publish a production release: :code:`tox -e release -- publish --final` #. Merge the PR to the trunk branch. diff --git a/release.py b/release.py index 1244d434..c4f06518 100644 --- a/release.py +++ b/release.py @@ -308,10 +308,14 @@ def bump() -> None: @main.command() @commandOption( - "--test/--production", help="Use test (or production) PyPI server" + "--test/--production", + help="Use test (or production) PyPI server", + default=False, ) @commandOption( - "--final/--candidate", help="Publish a final (or candidate) release" + "--final/--candidate", + help="Publish a final (or candidate) release", + default=False, ) def publish(final: bool, test: bool) -> None: publishRelease(final=final, test=test)