n24q02m/Python Semantic Release

Automated Releases via SemVer and Commit Message Conventions

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
config_filePath to a custom semantic-release configuration file. By default, an empty string will look for a pyproject.toml file in the current directory. This is the same as passing the `-c` or `--config` parameter to semantic-release. no""
directorySub-directory to cd into before running semantic-releaseno.
github_tokenGitHub token used to push release notes and new commits/tagsyes
git_committer_nameThe human name for the “committer” fieldno
git_committer_emailThe email address for the “committer” fieldno
no_operation_modeIf set to true, the github action will pass the `--noop` parameter to semantic-release. This will cause semantic-release to run in "no operation" mode. See the documentation for more information on this parameter. Note that, this parameter will not affect the output of the action, so you will still get the version determination decision as output values. nofalse
ssh_public_signing_keyThe ssh public key used to sign commitsno
ssh_private_signing_keyThe ssh private key used to sign commitsno
strictIf set to true, the github action will pass the `--strict` parameter to semantic-release. See the documentation for more information on this parameter. nofalse
verbositySet the verbosity level of the output as the number of -v's to pass to semantic-release. 0 is no extra output, 1 is info level output, 2 is debug output, and 3 is silly debug level of output. no1
prereleaseForce the next version to be a prerelease. Set to "true" or "false". no
prerelease_tokenForce the next version to use this prerelease token, if it is a prereleaseno
forceForce the next version to be a major release. Must be set to one of "prerelease", "patch", "minor", or "major". no
commitWhether or not to commit changes locally. Defaults are handled by python-semantic-release internal version command.no
tagWhether or not to make a local version tag. Defaults are handled by python-semantic-release internal version command. no
pushWhether or not to push local commits to the Git repository. See the configuration page for defaults of `semantic-release version` for how the default is determined between push, tag, & commit. no
changelogWhether or not to update the changelog. no
vcs_releaseWhether or not to create a release in the remote VCS, if supported no
buildWhether or not to run the build_command for the project. Defaults are handled by python-semantic-release internal version command. no
build_metadataBuild metadata to append to the new version no
namedescription
commit_shaThe commit SHA of the release if a release was made, otherwise an empty string
is_prerelease"true" if the version is a prerelease, "false" otherwise
linkThe link to the release in the remote VCS, if a release was made. If no release was made, this will be an empty string.
previous_versionThe previous version before the release, if a release was or will be made. If no release is detected, this will be the current version or an empty string if no previous version exists.
released"true" if a release was made, "false" otherwise
release_notesThe release notes generated by the release, if any. If no release was made, this will be an empty string.
tagThe Git tag corresponding to the version output
versionThe newly released version if one was made, otherwise the current version