semantic_release.cli module

CLI

semantic_release.cli.bump_version(new_version, level_bump)[source]

Set the version to the given new_version.

Edit in the source code, commit and create a git tag.

semantic_release.cli.changelog(*, unreleased=False, noop=False, post=False, prerelease=False, **kwargs)[source]

Generate the changelog since the last release.

Raises:

ImproperConfigurationError – if there is no current version

semantic_release.cli.common_options(func)[source]

Decorator that adds all the options in COMMON_OPTIONS

semantic_release.cli.entry()[source]
semantic_release.cli.filter_output_for_secrets(message)[source]

Remove secrets from cli output.

semantic_release.cli.print_version(*, current=False, force_level=None, prerelease=False, prerelease_patch=True, **kwargs)[source]

Print the current or new version to standard output.

semantic_release.cli.publish(retry: bool = False, noop: bool = False, prerelease: bool = False, prerelease_patch=True, **kwargs)[source]

Run the version task, then push to git and upload to an artifact repository / GitHub Releases.

semantic_release.cli.should_bump_version(*, current_version, current_release_version, new_version, prerelease, retry=False, noop=False)[source]
semantic_release.cli.version(*, retry=False, noop=False, force_level=None, prerelease=False, prerelease_patch=True, **kwargs)[source]

Detect the new version according to git log and semver.

Write the new version number and commit it, unless the noop option is True.