Command line reference¶

The flags below come from the parser used by the executable.

release-creator - CLI interface¶

Release preparation tools

release-creator [-h]
                {notes,changelog,fragments,validate-news,validate-fragment-deletions,anchors,tags,artifacts,marketplace,hooks} ...

release-creator options¶

-h, --help - show this help message and exit

release-creator notes¶

render notes from a tagged changelog

release-creator notes [-h] --changelog CHANGELOG --tag TAG --repository REPOSITORY
                      [--package PACKAGE] [--previous PREVIOUS] [--artifact-url ARTIFACT_URL]
                      [--artifact-label ARTIFACT_LABEL] [--generated-notes GENERATED_NOTES]

release-creator notes options¶

-h, --help - show this help message and exit
--changelog CHANGELOG - tagged Markdown or reStructuredText changelog
--tag TAG - release tag to render
--repository REPOSITORY - GitHub owner/repository
--package PACKAGE - package section in a shared Markdown changelog
--previous PREVIOUS - previous tag for the comparison link
--artifact-url ARTIFACT_URL - HTTPS link to the published package or artifact
--artifact-label ARTIFACT_LABEL - text for the artifact link (default: PyPI release)
--generated-notes GENERATED_NOTES - GitHub generated notes for New Contributors credits

release-creator changelog¶

render package history with current draft fragments

release-creator changelog [-h] --changelog CHANGELOG --format {package,knope}
                          [--package PACKAGE] [--config CONFIG] --fragments FRAGMENTS
                          --output OUTPUT

release-creator changelog options¶

-h, --help - show this help message and exit
--changelog CHANGELOG - shared Markdown changelog
--format {package,knope} - source changelog style
--package PACKAGE - package section for the package format
--config CONFIG - knope.toml for Knope changesets
--fragments FRAGMENTS - package fragment directory
--output OUTPUT - package documentation page

release-creator fragments¶

link fragments to their merged pull requests

release-creator fragments [-h] [--format {towncrier,knope}] [--directory DIRECTORY]
                          --repository REPOSITORY [--numbered-prs]

release-creator fragments options¶

-h, --help - show this help message and exit
--format {towncrier,knope} - fragment format (default: towncrier)
--directory DIRECTORY - fragment directory; defaults to changelog.d or .changeset
--repository REPOSITORY - GitHub owner/repository
--numbered-prs - treat numeric Towncrier fragment stems as PR numbers

release-creator validate-news¶

validate changed pull request fragments

release-creator validate-news [-h] [--format {towncrier,knope}] --base BASE

release-creator validate-news options¶

-h, --help - show this help message and exit
--format {towncrier,knope} - fragment format (default: towncrier)
--base BASE - pull request base branch

release-creator validate-fragment-deletions¶

check staged Towncrier fragment deletions

release-creator validate-fragment-deletions [-h]

release-creator validate-fragment-deletions options¶

-h, --help - show this help message and exit

release-creator anchors¶

add stable Markdown release and category anchors

release-creator anchors [-h] --changelog CHANGELOG

release-creator anchors options¶

-h, --help - show this help message and exit
--changelog CHANGELOG - assembled Markdown changelog

release-creator tags¶

calculate, validate, or compare numeric release tags

release-creator tags [-h] [--next {auto,major,minor,patch,calver} | --previous |
                     --require-newer] [--stable-only] [--prefix {v}] [--package PACKAGE]
                     [--directory DIRECTORY]
                     [tag]

release-creator tags positional arguments¶

tag - major.minor.patch release tag, optionally prefixed with v

release-creator tags options¶

-h, --help - show this help message and exit
--next {auto,major,minor,patch,calver} - calculate a version from pending fragments
--previous - print the preceding tag from standard input
--require-newer - require a tag newer than those on standard input
--stable-only - ignore prerelease and postrelease predecessors
--prefix {v} - prefix the calculated tag with v (default: )
--package PACKAGE - scope tags to package/ and print package-prefixed results
--directory DIRECTORY - pending fragment directory for --next; defaults to changelog.d[/package]

release-creator artifacts¶

verify every built file against its published PyPI release

release-creator artifacts [-h] --project PROJECT --version VERSION --dist DIST
                          [--wait-seconds WAIT_SECONDS]

release-creator artifacts options¶

-h, --help - show this help message and exit
--project PROJECT - PyPI project name
--version VERSION - PyPI release version
--dist DIST - directory of expected wheel and sdist files
--wait-seconds WAIT_SECONDS - bounded PyPI propagation wait for verification (default: 0)

release-creator marketplace¶

compare a signed ZIP with JetBrains Marketplace

release-creator marketplace [-h] --plugin-id PLUGIN_ID --version VERSION --archive ARCHIVE
                            [--mode {stage,verify}] [--github-output GITHUB_OUTPUT]

release-creator marketplace options¶

-h, --help - show this help message and exit
--plugin-id PLUGIN_ID - JetBrains plugin XML ID
--version VERSION - plugin version without a tag prefix
--archive ARCHIVE - signed local plugin ZIP
--mode {stage,verify} - comparison phase (default: stage)
--github-output GITHUB_OUTPUT - append publish=true or false to the GitHub step output

release-creator hooks¶

refresh exact pre-commit additional_dependencies pins

release-creator hooks [-h] --exclude-newer EXCLUDE_NEWER --python-version PYTHON_VERSION

release-creator hooks options¶

-h, --help - show this help message and exit
--exclude-newer EXCLUDE_NEWER - UTC cutoff for eligible package releases
--python-version PYTHON_VERSION - Python version used to resolve hook dependencies