NAME

repomatic create-release - Create the GitHub release draft of a version

SYNOPSIS

repomatic create-release [OPTIONS]

DESCRIPTION

Create the release draft of a version, with its notes and assets.

The notes are the changelog section of the version. A project published on PyPI gets them with the availability admonition linking to PyPI and GitHub, which lint-changelog later writes into the changelog itself.

The release stays a draft: the release workflow attaches the binaries and other assets to it, then publishes it last, since a published immutable release accepts no new asset.

Idempotent: with --skip-existing, the default, a release that already carries the tag is left as it is, so a re-run of the workflow passes.

OPTIONS

--version TEXT: Version to release, like 1.2.3. The release takes the tag v1.2.3.
[required]
--commit TEXT: Commit the release tag points at. Defaults to HEAD.
--assets DIRECTORY: Directory of files to attach to the draft. A directory that does not exist attaches nothing.
--skip-existing / --error-existing: Skip silently if a release carries the tag, or fail with an error.
--changelog FILE: Path to the changelog file. Defaults to [tool.repomatic] changelog.location.
--repo TEXT: Repository in owner/repo format. Defaults to $GITHUB_REPOSITORY, then to the GitHub remote of the current clone.
--help / -h: Show this message and exit.

ENVIRONMENT

CREATE_RELEASE_VERSION_STR: Version to release, like 1.2.3. The release takes the tag v1.2.3.
CREATE_RELEASE_COMMIT: Commit the release tag points at. Defaults to HEAD.
CREATE_RELEASE_ASSET_DIR: Directory of files to attach to the draft. A directory that does not exist attaches nothing.
CREATE_RELEASE_SKIP_EXISTING: Skip silently if a release carries the tag, or fail with an error.
CREATE_RELEASE_CHANGELOG_PATH: Path to the changelog file. Defaults to [tool.repomatic] changelog.location.
GITHUB_REPOSITORY: Repository in owner/repo format. Defaults to $GITHUB_REPOSITORY, then to the GitHub remote of the current clone.
CREATE_RELEASE_REPO: Repository in owner/repo format. Defaults to $GITHUB_REPOSITORY, then to the GitHub remote of the current clone.
CREATE_RELEASE__CLICK_DEFAULT_HELP: Show this message and exit.

EXIT STATUS

0: Success.
1: A runtime error, an aborted prompt (Ctrl-D), or a declined confirmation.
2: A usage error: unknown option, invalid value, missing operand, or an unparsable configuration file.
130: Interrupted with Ctrl-C: the process ends by SIGINT, reported as 130.

EXAMPLES

Create the draft of the release commit, attaching the built package

repomatic create\-release \-\-version 1.2.3 \-\-commit 6f27db4 \-\-assets release_artifact

AUTHORS

Kevin Deldycke