Skip to content

Commit

Permalink
default to release candidate please
Browse files Browse the repository at this point in the history
  • Loading branch information
glyph committed Dec 21, 2023
1 parent 737c32a commit bde4a64
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 6 additions & 2 deletions release.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit bde4a64

Please sign in to comment.