Releaser CLI#
jupyter-releaser#
Jupyter Releaser scripts
.. program:: jupyter-releaser .. code-block:: shell
jupyter-releaser [OPTIONS] COMMAND [ARGS]...
.. rubric:: Options
.. option:: –force
Force a command to run even when skipped by config
build-changelog#
Build changelog entry
.. program:: jupyter-releaser build-changelog .. code-block:: shell
jupyter-releaser build-changelog [OPTIONS]
.. rubric:: Options
The source reference
.. option:: –branch
The target branch
.. option:: –repo
The git repo
.. option:: –auth
The GitHub auth token
.. option:: –changelog-path <changelog_path>
The path to changelog file
.. option:: –since
Use PRs with activity since this date or git reference
.. option:: –since-last-stable
Use PRs with activity since the last stable git tag
.. option:: –resolve-backports <resolve_backports>
Resolve backport PRs to their originals
.. rubric:: Environment variables
.. _jupyter-releaser-build-changelog-ref-RH_REF:
.. envvar:: RH_REF :noindex:
Provide a default for :option:`--ref`
.. _jupyter-releaser-build-changelog-branch-RH_BRANCH:
.. envvar:: RH_BRANCH :noindex:
Provide a default for :option:`--branch`
.. _jupyter-releaser-build-changelog-repo-RH_REPOSITORY:
.. envvar:: RH_REPOSITORY :noindex:
Provide a default for :option:`--repo`
.. _jupyter-releaser-build-changelog-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-build-changelog-changelog_path-RH_CHANGELOG:
.. envvar:: RH_CHANGELOG :noindex:
Provide a default for :option:`--changelog-path`
.. _jupyter-releaser-build-changelog-since-RH_SINCE:
.. envvar:: RH_SINCE :noindex:
Provide a default for :option:`--since`
.. _jupyter-releaser-build-changelog-since_last_stable-RH_SINCE_LAST_STABLE:
.. envvar:: RH_SINCE_LAST_STABLE :noindex:
Provide a default for :option:`--since-last-stable`
.. _jupyter-releaser-build-changelog-resolve_backports-RH_RESOLVE_BACKPORTS:
.. envvar:: RH_RESOLVE_BACKPORTS :noindex:
Provide a default for :option:`--resolve-backports`
build-npm#
Build npm package
.. program:: jupyter-releaser build-npm .. code-block:: shell
jupyter-releaser build-npm [OPTIONS] [PACKAGE]
.. rubric:: Options
.. option:: –dist-dir <dist_dir>
The folder to use for dist files
.. rubric:: Arguments
.. option:: PACKAGE
Optional argument
.. rubric:: Environment variables
.. _jupyter-releaser-build-npm-dist_dir-RH_DIST_DIR:
.. envvar:: RH_DIST_DIR :noindex:
Provide a default for :option:`--dist-dir`
build-python#
Build Python dist files
.. program:: jupyter-releaser build-python .. code-block:: shell
jupyter-releaser build-python [OPTIONS]
.. rubric:: Options
.. option:: –dist-dir <dist_dir>
The folder to use for dist files
.. option:: –python-packages <python_packages>
The list of strings of the form "path_to_package:name_of_package"
.. rubric:: Environment variables
.. _jupyter-releaser-build-python-dist_dir-RH_DIST_DIR:
.. envvar:: RH_DIST_DIR :noindex:
Provide a default for :option:`--dist-dir`
.. _jupyter-releaser-build-python-python_packages-RH_PYTHON_PACKAGES:
.. envvar:: RH_PYTHON_PACKAGES :noindex:
Provide a default for :option:`--python-packages`
bump-version#
Prep git and env variables and bump version
.. program:: jupyter-releaser bump-version .. code-block:: shell
jupyter-releaser bump-version [OPTIONS]
.. rubric:: Options
.. option:: –version-spec <version_spec>
The new version specifier
.. option:: –version-cmd <version_cmd>
The version command
.. option:: –changelog-path <changelog_path>
The path to changelog file
.. option:: –python-packages <python_packages>
The list of strings of the form "path_to_package:name_of_package"
.. option:: –tag-format <tag_format>
The format to use for the release tag
.. rubric:: Environment variables
.. _jupyter-releaser-bump-version-version_spec-RH_VERSION_SPEC:
.. envvar:: RH_VERSION_SPEC :noindex:
Provide a default for :option:`--version-spec`
.. _jupyter-releaser-bump-version-version_cmd-RH_VERSION_COMMAND:
.. envvar:: RH_VERSION_COMMAND :noindex:
Provide a default for :option:`--version-cmd`
.. _jupyter-releaser-bump-version-changelog_path-RH_CHANGELOG:
.. envvar:: RH_CHANGELOG :noindex:
Provide a default for :option:`--changelog-path`
.. _jupyter-releaser-bump-version-python_packages-RH_PYTHON_PACKAGES:
.. envvar:: RH_PYTHON_PACKAGES :noindex:
Provide a default for :option:`--python-packages`
.. _jupyter-releaser-bump-version-tag_format-RH_TAG_FORMAT:
.. envvar:: RH_TAG_FORMAT :noindex:
Provide a default for :option:`--tag-format`
check-npm#
Check npm package
.. program:: jupyter-releaser check-npm .. code-block:: shell
jupyter-releaser check-npm [OPTIONS]
.. rubric:: Options
.. option:: –dist-dir <dist_dir>
The folder to use for dist files
.. option:: –npm-install-options <npm_install_options>
Options to pass when calling npm install
.. option:: –repo
The git repo
.. rubric:: Environment variables
.. _jupyter-releaser-check-npm-dist_dir-RH_DIST_DIR:
.. envvar:: RH_DIST_DIR :noindex:
Provide a default for :option:`--dist-dir`
.. _jupyter-releaser-check-npm-npm_install_options-RH_NPM_INSTALL_OPTIONS:
.. envvar:: RH_NPM_INSTALL_OPTIONS :noindex:
Provide a default for :option:`--npm-install-options`
.. _jupyter-releaser-check-npm-repo-RH_REPOSITORY:
.. envvar:: RH_REPOSITORY :noindex:
Provide a default for :option:`--repo`
check-python#
Check Python dist files
.. program:: jupyter-releaser check-python .. code-block:: shell
jupyter-releaser check-python [OPTIONS]
.. rubric:: Options
.. option:: –dist-dir <dist_dir>
The folder to use for dist files
.. option:: –check-imports <check_imports>
The Python packages import to check for; default to the Python package name.
.. option:: –pydist-check-cmd <pydist_check_cmd>
The command to use to check a python distribution file
.. option:: –pydist-extra-check-cmds <pydist_extra_check_cmds>
Extra checks to run against the pydist file
.. option:: –pydist-resource-paths <pydist_resource_paths>
Resource paths that should be available when installed
.. rubric:: Environment variables
.. _jupyter-releaser-check-python-dist_dir-RH_DIST_DIR:
.. envvar:: RH_DIST_DIR :noindex:
Provide a default for :option:`--dist-dir`
.. _jupyter-releaser-check-python-check_imports-RH_CHECK_IMPORTS:
.. envvar:: RH_CHECK_IMPORTS :noindex:
Provide a default for :option:`--check-imports`
.. _jupyter-releaser-check-python-pydist_check_cmd-RH_PYDIST_CHECK_CMD:
.. envvar:: RH_PYDIST_CHECK_CMD :noindex:
Provide a default for :option:`--pydist-check-cmd`
.. _jupyter-releaser-check-python-pydist_extra_check_cmds-RH_EXTRA_PYDIST_CHECK_CMDS:
.. envvar:: RH_EXTRA_PYDIST_CHECK_CMDS :noindex:
Provide a default for :option:`--pydist-extra-check-cmds`
.. _jupyter-releaser-check-python-pydist_resource_paths-RH_PYDIST_RESOURCE_PATHS:
.. envvar:: RH_PYDIST_RESOURCE_PATHS :noindex:
Provide a default for :option:`--pydist-resource-paths`
delete-release#
Delete a draft GitHub release by url to the release page
.. program:: jupyter-releaser delete-release .. code-block:: shell
jupyter-releaser delete-release [OPTIONS]
.. rubric:: Options
.. option:: –auth
The GitHub auth token
.. option:: –dry-run
Run as a dry run
.. option:: –release-url <release_url>
A draft GitHub release url
.. rubric:: Environment variables
.. _jupyter-releaser-delete-release-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-delete-release-dry_run-RH_DRY_RUN:
.. envvar:: RH_DRY_RUN :noindex:
Provide a default for :option:`--dry-run`
.. _jupyter-releaser-delete-release-release_url-RH_RELEASE_URL:
.. envvar:: RH_RELEASE_URL :noindex:
Provide a default for :option:`--release-url`
draft-changelog#
Create a changelog entry PR
.. program:: jupyter-releaser draft-changelog .. code-block:: shell
jupyter-releaser draft-changelog [OPTIONS]
.. rubric:: Options
.. option:: –version-spec <version_spec>
The new version specifier
The source reference
.. option:: –branch
The target branch
.. option:: –repo
The git repo
.. option:: –since
Use PRs with activity since this date or git reference
.. option:: –since-last-stable
Use PRs with activity since the last stable git tag
.. option:: –auth
The GitHub auth token
.. option:: –changelog-path <changelog_path>
The path to changelog file
.. option:: –dry-run
Run as a dry run
.. option:: –post-version-spec <post_version_spec>
The post release version (usually dev)
.. option:: –post-version-message <post_version_message>
The post release message
.. option:: –silent
Set a placeholder in the changelog.
.. option:: –tag-format <tag_format>
The format to use for the release tag
.. rubric:: Environment variables
.. _jupyter-releaser-draft-changelog-version_spec-RH_VERSION_SPEC:
.. envvar:: RH_VERSION_SPEC :noindex:
Provide a default for :option:`--version-spec`
.. _jupyter-releaser-draft-changelog-ref-RH_REF:
.. envvar:: RH_REF :noindex:
Provide a default for :option:`--ref`
.. _jupyter-releaser-draft-changelog-branch-RH_BRANCH:
.. envvar:: RH_BRANCH :noindex:
Provide a default for :option:`--branch`
.. _jupyter-releaser-draft-changelog-repo-RH_REPOSITORY:
.. envvar:: RH_REPOSITORY :noindex:
Provide a default for :option:`--repo`
.. _jupyter-releaser-draft-changelog-since-RH_SINCE:
.. envvar:: RH_SINCE :noindex:
Provide a default for :option:`--since`
.. _jupyter-releaser-draft-changelog-since_last_stable-RH_SINCE_LAST_STABLE:
.. envvar:: RH_SINCE_LAST_STABLE :noindex:
Provide a default for :option:`--since-last-stable`
.. _jupyter-releaser-draft-changelog-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-draft-changelog-changelog_path-RH_CHANGELOG:
.. envvar:: RH_CHANGELOG :noindex:
Provide a default for :option:`--changelog-path`
.. _jupyter-releaser-draft-changelog-dry_run-RH_DRY_RUN:
.. envvar:: RH_DRY_RUN :noindex:
Provide a default for :option:`--dry-run`
.. _jupyter-releaser-draft-changelog-post_version_spec-RH_POST_VERSION_SPEC:
.. envvar:: RH_POST_VERSION_SPEC :noindex:
Provide a default for :option:`--post-version-spec`
.. _jupyter-releaser-draft-changelog-post_version_message-RH_POST_VERSION_MESSAGE:
.. envvar:: RH_POST_VERSION_MESSAGE :noindex:
Provide a default for :option:`--post-version-message`
.. _jupyter-releaser-draft-changelog-silent-RH_SILENT:
.. envvar:: RH_SILENT :noindex:
Provide a default for :option:`--silent`
.. _jupyter-releaser-draft-changelog-tag_format-RH_TAG_FORMAT:
.. envvar:: RH_TAG_FORMAT :noindex:
Provide a default for :option:`--tag-format`
ensure-sha#
Ensure that a sha has not changed.
.. program:: jupyter-releaser ensure-sha .. code-block:: shell
jupyter-releaser ensure-sha [OPTIONS]
.. rubric:: Options
The source reference
.. option:: –branch
The target branch
.. option:: –repo
The git repo
.. option:: –dry-run
Run as a dry run
.. option:: –expected-sha <expected_sha>
The expected sha of the branch HEAD
.. rubric:: Environment variables
.. _jupyter-releaser-ensure-sha-ref-RH_REF:
.. envvar:: RH_REF :noindex:
Provide a default for :option:`--ref`
.. _jupyter-releaser-ensure-sha-branch-RH_BRANCH:
.. envvar:: RH_BRANCH :noindex:
Provide a default for :option:`--branch`
.. _jupyter-releaser-ensure-sha-repo-RH_REPOSITORY:
.. envvar:: RH_REPOSITORY :noindex:
Provide a default for :option:`--repo`
.. _jupyter-releaser-ensure-sha-dry_run-RH_DRY_RUN:
.. envvar:: RH_DRY_RUN :noindex:
Provide a default for :option:`--dry-run`
.. _jupyter-releaser-ensure-sha-expected_sha-RH_EXPECTED_SHA:
.. envvar:: RH_EXPECTED_SHA :noindex:
Provide a default for :option:`--expected-sha`
extract-changelog#
Extract the changelog entry.
.. program:: jupyter-releaser extract-changelog .. code-block:: shell
jupyter-releaser extract-changelog [OPTIONS]
.. rubric:: Options
.. option:: –dry-run
Run as a dry run
.. option:: –auth
The GitHub auth token
.. option:: –changelog-path <changelog_path>
The path to changelog file
.. option:: –release-url <release_url>
A draft GitHub release url
.. option:: –silent
Set a placeholder in the changelog.
.. rubric:: Environment variables
.. _jupyter-releaser-extract-changelog-dry_run-RH_DRY_RUN:
.. envvar:: RH_DRY_RUN :noindex:
Provide a default for :option:`--dry-run`
.. _jupyter-releaser-extract-changelog-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-extract-changelog-changelog_path-RH_CHANGELOG:
.. envvar:: RH_CHANGELOG :noindex:
Provide a default for :option:`--changelog-path`
.. _jupyter-releaser-extract-changelog-release_url-RH_RELEASE_URL:
.. envvar:: RH_RELEASE_URL :noindex:
Provide a default for :option:`--release-url`
.. _jupyter-releaser-extract-changelog-silent-RH_SILENT:
.. envvar:: RH_SILENT :noindex:
Provide a default for :option:`--silent`
extract-release#
Download and verify assets from a draft GitHub release
.. program:: jupyter-releaser extract-release .. code-block:: shell
jupyter-releaser extract-release [OPTIONS]
.. rubric:: Options
.. option:: –auth
The GitHub auth token
.. option:: –dist-dir <dist_dir>
The folder to use for dist files
.. option:: –dry-run
Run as a dry run
.. option:: –release-url <release_url>
A draft GitHub release url
.. rubric:: Environment variables
.. _jupyter-releaser-extract-release-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-extract-release-dist_dir-RH_DIST_DIR:
.. envvar:: RH_DIST_DIR :noindex:
Provide a default for :option:`--dist-dir`
.. _jupyter-releaser-extract-release-dry_run-RH_DRY_RUN:
.. envvar:: RH_DRY_RUN :noindex:
Provide a default for :option:`--dry-run`
.. _jupyter-releaser-extract-release-release_url-RH_RELEASE_URL:
.. envvar:: RH_RELEASE_URL :noindex:
Provide a default for :option:`--release-url`
forwardport-changelog#
Forwardport Changelog Entries to the Default Branch
.. program:: jupyter-releaser forwardport-changelog .. code-block:: shell
jupyter-releaser forwardport-changelog [OPTIONS]
.. rubric:: Options
.. option:: –auth
The GitHub auth token
The source reference
.. option:: –branch
The target branch
.. option:: –repo
The git repo
.. option:: –username
The git username
.. option:: –changelog-path <changelog_path>
The path to changelog file
.. option:: –dry-run
Run as a dry run
.. option:: –release-url <release_url>
A draft GitHub release url
.. rubric:: Environment variables
.. _jupyter-releaser-forwardport-changelog-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-forwardport-changelog-ref-RH_REF:
.. envvar:: RH_REF :noindex:
Provide a default for :option:`--ref`
.. _jupyter-releaser-forwardport-changelog-branch-RH_BRANCH:
.. envvar:: RH_BRANCH :noindex:
Provide a default for :option:`--branch`
.. _jupyter-releaser-forwardport-changelog-repo-RH_REPOSITORY:
.. envvar:: RH_REPOSITORY :noindex:
Provide a default for :option:`--repo`
.. _jupyter-releaser-forwardport-changelog-username-GITHUB_ACTOR:
.. envvar:: GITHUB_ACTOR :noindex:
Provide a default for :option:`--username`
.. _jupyter-releaser-forwardport-changelog-changelog_path-RH_CHANGELOG:
.. envvar:: RH_CHANGELOG :noindex:
Provide a default for :option:`--changelog-path`
.. _jupyter-releaser-forwardport-changelog-dry_run-RH_DRY_RUN:
.. envvar:: RH_DRY_RUN :noindex:
Provide a default for :option:`--dry-run`
.. _jupyter-releaser-forwardport-changelog-release_url-RH_RELEASE_URL:
.. envvar:: RH_RELEASE_URL :noindex:
Provide a default for :option:`--release-url`
list-envvars#
List the environment variables
.. program:: jupyter-releaser list-envvars .. code-block:: shell
jupyter-releaser list-envvars [OPTIONS]
populate-release#
Populate a release.
.. program:: jupyter-releaser populate-release .. code-block:: shell
jupyter-releaser populate-release [OPTIONS] [ASSETS]...
.. rubric:: Options
The source reference
.. option:: –branch
The target branch
.. option:: –repo
The git repo
.. option:: –version-cmd <version_cmd>
The version command
.. option:: –auth
The GitHub auth token
.. option:: –changelog-path <changelog_path>
The path to changelog file
.. option:: –dist-dir <dist_dir>
The folder to use for dist files
.. option:: –dry-run
Run as a dry run
.. option:: –release-url <release_url>
A draft GitHub release url
.. option:: –post-version-spec <post_version_spec>
The post release version (usually dev)
.. option:: –post-version-message <post_version_message>
The post release message
.. option:: –silent
Set a placeholder in the changelog.
.. option:: –tag-format <tag_format>
The format to use for the release tag
.. rubric:: Arguments
.. option:: ASSETS
Optional argument(s)
.. rubric:: Environment variables
.. _jupyter-releaser-populate-release-ref-RH_REF:
.. envvar:: RH_REF :noindex:
Provide a default for :option:`--ref`
.. _jupyter-releaser-populate-release-branch-RH_BRANCH:
.. envvar:: RH_BRANCH :noindex:
Provide a default for :option:`--branch`
.. _jupyter-releaser-populate-release-repo-RH_REPOSITORY:
.. envvar:: RH_REPOSITORY :noindex:
Provide a default for :option:`--repo`
.. _jupyter-releaser-populate-release-version_cmd-RH_VERSION_COMMAND:
.. envvar:: RH_VERSION_COMMAND :noindex:
Provide a default for :option:`--version-cmd`
.. _jupyter-releaser-populate-release-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-populate-release-changelog_path-RH_CHANGELOG:
.. envvar:: RH_CHANGELOG :noindex:
Provide a default for :option:`--changelog-path`
.. _jupyter-releaser-populate-release-dist_dir-RH_DIST_DIR:
.. envvar:: RH_DIST_DIR :noindex:
Provide a default for :option:`--dist-dir`
.. _jupyter-releaser-populate-release-dry_run-RH_DRY_RUN:
.. envvar:: RH_DRY_RUN :noindex:
Provide a default for :option:`--dry-run`
.. _jupyter-releaser-populate-release-release_url-RH_RELEASE_URL:
.. envvar:: RH_RELEASE_URL :noindex:
Provide a default for :option:`--release-url`
.. _jupyter-releaser-populate-release-post_version_spec-RH_POST_VERSION_SPEC:
.. envvar:: RH_POST_VERSION_SPEC :noindex:
Provide a default for :option:`--post-version-spec`
.. _jupyter-releaser-populate-release-post_version_message-RH_POST_VERSION_MESSAGE:
.. envvar:: RH_POST_VERSION_MESSAGE :noindex:
Provide a default for :option:`--post-version-message`
.. _jupyter-releaser-populate-release-silent-RH_SILENT:
.. envvar:: RH_SILENT :noindex:
Provide a default for :option:`--silent`
.. _jupyter-releaser-populate-release-tag_format-RH_TAG_FORMAT:
.. envvar:: RH_TAG_FORMAT :noindex:
Provide a default for :option:`--tag-format`
prep-git#
Prep git and env variables and bump version
.. program:: jupyter-releaser prep-git .. code-block:: shell
jupyter-releaser prep-git [OPTIONS]
.. rubric:: Options
The source reference
.. option:: –branch
The target branch
.. option:: –repo
The git repo
.. option:: –auth
The GitHub auth token
.. option:: –username
The git username
.. option:: –git-url <git_url>
A custom url for the git repository
.. rubric:: Environment variables
.. _jupyter-releaser-prep-git-ref-RH_REF:
.. envvar:: RH_REF :noindex:
Provide a default for :option:`--ref`
.. _jupyter-releaser-prep-git-branch-RH_BRANCH:
.. envvar:: RH_BRANCH :noindex:
Provide a default for :option:`--branch`
.. _jupyter-releaser-prep-git-repo-RH_REPOSITORY:
.. envvar:: RH_REPOSITORY :noindex:
Provide a default for :option:`--repo`
.. _jupyter-releaser-prep-git-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-prep-git-username-GITHUB_ACTOR:
.. envvar:: GITHUB_ACTOR :noindex:
Provide a default for :option:`--username`
publish-assets#
Publish release asset(s)
.. program:: jupyter-releaser publish-assets .. code-block:: shell
jupyter-releaser publish-assets [OPTIONS]
.. rubric:: Options
.. option:: –auth
The GitHub auth token
.. option:: –dist-dir <dist_dir>
The folder to use for dist files
.. option:: –npm-token <npm_token>
A token for the npm release
.. option:: –npm-cmd <npm_cmd>
The command to run for npm release
.. option:: –twine-cmd <twine_cmd>
The twine to run for Python release
.. option:: –npm-registry <npm_registry>
The npm registry to target for publishing
.. option:: –twine-repository-url <twine_repository_url>
The pypi registry to target for publishing
.. option:: –npm-tag <npm_tag>
The npm tag. It defaults to 'next' if it is a prerelease otherwise to 'latest'.
.. option:: –dry-run
Run as a dry run
.. option:: –python-packages <python_packages>
The list of strings of the form "path_to_package:name_of_package"
.. option:: –release-url <release_url>
A draft GitHub release url
.. rubric:: Environment variables
.. _jupyter-releaser-publish-assets-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-publish-assets-dist_dir-RH_DIST_DIR:
.. envvar:: RH_DIST_DIR :noindex:
Provide a default for :option:`--dist-dir`
.. _jupyter-releaser-publish-assets-npm_token-NPM_TOKEN:
.. envvar:: NPM_TOKEN :noindex:
Provide a default for :option:`--npm-token`
.. _jupyter-releaser-publish-assets-npm_cmd-RH_NPM_COMMAND:
.. envvar:: RH_NPM_COMMAND :noindex:
Provide a default for :option:`--npm-cmd`
.. _jupyter-releaser-publish-assets-twine_cmd-TWINE_COMMAND:
.. envvar:: TWINE_COMMAND :noindex:
Provide a default for :option:`--twine-cmd`
.. _jupyter-releaser-publish-assets-npm_registry-NPM_REGISTRY:
.. envvar:: NPM_REGISTRY :noindex:
Provide a default for :option:`--npm-registry`
.. _jupyter-releaser-publish-assets-twine_repository_url-TWINE_REPOSITORY_URL:
.. envvar:: TWINE_REPOSITORY_URL :noindex:
Provide a default for :option:`--twine-repository-url`
.. _jupyter-releaser-publish-assets-npm_tag-NPM_TAG:
.. envvar:: NPM_TAG :noindex:
Provide a default for :option:`--npm-tag`
.. _jupyter-releaser-publish-assets-dry_run-RH_DRY_RUN:
.. envvar:: RH_DRY_RUN :noindex:
Provide a default for :option:`--dry-run`
.. _jupyter-releaser-publish-assets-python_packages-RH_PYTHON_PACKAGES:
.. envvar:: RH_PYTHON_PACKAGES :noindex:
Provide a default for :option:`--python-packages`
.. _jupyter-releaser-publish-assets-release_url-RH_RELEASE_URL:
.. envvar:: RH_RELEASE_URL :noindex:
Provide a default for :option:`--release-url`
publish-changelog#
Remove changelog placeholder entries.
.. program:: jupyter-releaser publish-changelog .. code-block:: shell
jupyter-releaser publish-changelog [OPTIONS]
.. rubric:: Options
.. option:: –auth
The GitHub auth token
The source reference
.. option:: –branch
The target branch
.. option:: –repo
The git repo
.. option:: –changelog-path <changelog_path>
The path to changelog file
.. option:: –dry-run
Run as a dry run
.. rubric:: Environment variables
.. _jupyter-releaser-publish-changelog-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-publish-changelog-ref-RH_REF:
.. envvar:: RH_REF :noindex:
Provide a default for :option:`--ref`
.. _jupyter-releaser-publish-changelog-branch-RH_BRANCH:
.. envvar:: RH_BRANCH :noindex:
Provide a default for :option:`--branch`
.. _jupyter-releaser-publish-changelog-repo-RH_REPOSITORY:
.. envvar:: RH_REPOSITORY :noindex:
Provide a default for :option:`--repo`
.. _jupyter-releaser-publish-changelog-changelog_path-RH_CHANGELOG:
.. envvar:: RH_CHANGELOG :noindex:
Provide a default for :option:`--changelog-path`
.. _jupyter-releaser-publish-changelog-dry_run-RH_DRY_RUN:
.. envvar:: RH_DRY_RUN :noindex:
Provide a default for :option:`--dry-run`
publish-release#
Publish GitHub release
.. program:: jupyter-releaser publish-release .. code-block:: shell
jupyter-releaser publish-release [OPTIONS]
.. rubric:: Options
.. option:: –auth
The GitHub auth token
.. option:: –dry-run
Run as a dry run
.. option:: –release-url <release_url>
A draft GitHub release url
.. option:: –silent
Set a placeholder in the changelog.
.. rubric:: Environment variables
.. _jupyter-releaser-publish-release-auth-GITHUB_ACCESS_TOKEN:
.. envvar:: GITHUB_ACCESS_TOKEN :noindex:
Provide a default for :option:`--auth`
.. _jupyter-releaser-publish-release-dry_run-RH_DRY_RUN:
.. envvar:: RH_DRY_RUN :noindex:
Provide a default for :option:`--dry-run`
.. _jupyter-releaser-publish-release-release_url-RH_RELEASE_URL:
.. envvar:: RH_RELEASE_URL :noindex:
Provide a default for :option:`--release-url`
.. _jupyter-releaser-publish-release-silent-RH_SILENT:
.. envvar:: RH_SILENT :noindex:
Provide a default for :option:`--silent`
tag-release#
Create release commit and tag
.. program:: jupyter-releaser tag-release .. code-block:: shell
jupyter-releaser tag-release [OPTIONS]
.. rubric:: Options
.. option:: –dist-dir <dist_dir>
The folder to use for dist files
.. option:: –release-message <release_message>
The message to use for the release commit
.. option:: –tag-format <tag_format>
The format to use for the release tag
.. option:: –tag-message <tag_message>
The message to use for the release tag
.. option:: –no-git-tag-workspace
Whether to skip tagging npm workspace packages
.. rubric:: Environment variables
.. _jupyter-releaser-tag-release-dist_dir-RH_DIST_DIR:
.. envvar:: RH_DIST_DIR :noindex:
Provide a default for :option:`--dist-dir`
.. _jupyter-releaser-tag-release-release_message-RH_RELEASE_MESSAGE:
.. envvar:: RH_RELEASE_MESSAGE :noindex:
Provide a default for :option:`--release-message`
.. _jupyter-releaser-tag-release-tag_format-RH_TAG_FORMAT:
.. envvar:: RH_TAG_FORMAT :noindex:
Provide a default for :option:`--tag-format`
.. _jupyter-releaser-tag-release-tag_message-RH_TAG_MESSAGE:
.. envvar:: RH_TAG_MESSAGE :noindex:
Provide a default for :option:`--tag-message`