semantic_release package

Python Semantic Release

semantic_release.setup_hook(argv: list[str]) → None

A hook to be used in setup.py to enable python setup.py publish.

Parameters:

argv – sys.argv

Subpackages

• semantic_release.changelog package
  • Submodules
    • semantic_release.changelog.context module
    • semantic_release.changelog.release_history module
    • semantic_release.changelog.template module
• semantic_release.cli package
  • Subpackages
    • semantic_release.cli.commands package
  • Submodules
    • semantic_release.cli.common module
    • semantic_release.cli.config module
    • semantic_release.cli.const module
    • semantic_release.cli.github_actions_output module
    • semantic_release.cli.masking_filter module
    • semantic_release.cli.util module
• semantic_release.commit_parser package
  • Submodules
    • semantic_release.commit_parser.angular module
    • semantic_release.commit_parser.emoji module
    • semantic_release.commit_parser.scipy module
    • semantic_release.commit_parser.tag module
    • semantic_release.commit_parser.token module
    • semantic_release.commit_parser.util module
• semantic_release.hvcs package
  • Bitbucket
    • Bitbucket.DEFAULT_API_PATH_CLOUD
    • Bitbucket.DEFAULT_API_PATH_ONPREM
    • Bitbucket.DEFAULT_API_SUBDOMAIN_PREFIX
    • Bitbucket.DEFAULT_API_URL_CLOUD
    • Bitbucket.DEFAULT_DOMAIN
    • Bitbucket.DEFAULT_ENV_TOKEN_NAME
    • Bitbucket.commit_hash_url()
    • Bitbucket.compare_url()
    • Bitbucket.create_or_update_release()
    • Bitbucket.create_release()
    • Bitbucket.get_changelog_context_filters()
    • Bitbucket.pull_request_url()
    • Bitbucket.remote_url()
    • Bitbucket.upload_dists()
  • Gitea
    • Gitea.DEFAULT_API_PATH
    • Gitea.DEFAULT_DOMAIN
    • Gitea.DEFAULT_ENV_TOKEN_NAME
    • Gitea.asset_upload_url()
    • Gitea.commit_hash_url()
    • Gitea.create_or_update_release()
    • Gitea.create_release()
    • Gitea.edit_release_notes()
    • Gitea.get_changelog_context_filters()
    • Gitea.get_release_id_by_tag()
    • Gitea.issue_url()
    • Gitea.pull_request_url()
    • Gitea.remote_url()
    • Gitea.upload_dists()
    • Gitea.upload_release_asset()
  • Github
    • Github.DEFAULT_API_DOMAIN
    • Github.DEFAULT_API_PATH_CLOUD
    • Github.DEFAULT_API_PATH_ONPREM
    • Github.DEFAULT_API_SUBDOMAIN_PREFIX
    • Github.DEFAULT_API_URL_CLOUD
    • Github.DEFAULT_DOMAIN
    • Github.DEFAULT_ENV_TOKEN_NAME
    • Github.asset_upload_url()
    • Github.commit_hash_url()
    • Github.compare_url()
    • Github.create_or_update_release()
    • Github.create_release()
    • Github.edit_release_notes()
    • Github.get_changelog_context_filters()
    • Github.get_release_id_by_tag()
    • Github.issue_url()
    • Github.pull_request_url()
    • Github.remote_url()
    • Github.upload_dists()
    • Github.upload_release_asset()
  • Gitlab
    • Gitlab.DEFAULT_DOMAIN
    • Gitlab.DEFAULT_ENV_TOKEN_NAME
    • Gitlab.commit_hash_url()
    • Gitlab.compare_url()
    • Gitlab.create_or_update_release()
    • Gitlab.create_release()
    • Gitlab.edit_release_notes()
    • Gitlab.get_changelog_context_filters()
    • Gitlab.issue_url()
    • Gitlab.merge_request_url()
    • Gitlab.pull_request_url()
    • Gitlab.remote_url()
    • Gitlab.upload_dists()
  • HvcsBase
    • HvcsBase.get_changelog_context_filters()
    • HvcsBase.owner
    • HvcsBase.remote_url()
    • HvcsBase.repo_name
  • RemoteHvcsBase
    • RemoteHvcsBase.DEFAULT_ENV_TOKEN_NAME
    • RemoteHvcsBase.api_url
    • RemoteHvcsBase.create_api_url()
    • RemoteHvcsBase.create_or_update_release()
    • RemoteHvcsBase.create_release()
    • RemoteHvcsBase.create_repo_url()
    • RemoteHvcsBase.create_server_url()
    • RemoteHvcsBase.hvcs_domain
    • RemoteHvcsBase.upload_dists()
  • TokenAuth
  • Submodules
    • semantic_release.hvcs.bitbucket module
    • semantic_release.hvcs.gitea module
    • semantic_release.hvcs.github module
    • semantic_release.hvcs.gitlab module
    • semantic_release.hvcs.remote_hvcs_base module
    • semantic_release.hvcs.token_auth module
    • semantic_release.hvcs.util module
• semantic_release.version package
  • Submodules
    • semantic_release.version.algorithm module
    • semantic_release.version.declaration module
    • semantic_release.version.translator module
    • semantic_release.version.version module

Submodules

• semantic_release.const module
• semantic_release.enums module
  • LevelBump
    • LevelBump.MAJOR
    • LevelBump.MINOR
    • LevelBump.NO_RELEASE
    • LevelBump.PATCH
    • LevelBump.PRERELEASE_REVISION
    • LevelBump.from_string()
• semantic_release.errors module
  • AssetUploadError
  • CommitParseError
  • IncompleteReleaseError
  • InvalidConfiguration
  • InvalidVersion
  • MissingMergeBaseError
  • NotAReleaseBranch
  • ParserLoadError
  • SemanticReleaseBaseError
  • UnexpectedResponse
• semantic_release.helpers module
  • ParsedGitUrl
    • ParsedGitUrl.namespace
    • ParsedGitUrl.netloc
    • ParsedGitUrl.repo_name
    • ParsedGitUrl.scheme
  • check_tag_format()
  • dynamic_import()
  • format_arg()
  • logged_function()
  • parse_git_url()