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