Jupyter Releaser

Jupyter Releaser contains a set of helper scripts and GitHub Actions to aid in automated releases of Python and npm packages.

Installation

To install the latest release locally, make sure you have pip installed and run:

    pip install git+https://github.com/jupyter-server/jupyter-releaser

Library Usage

    jupyter-releaser --help
    jupyter-releaser build-python --help
    jupyter-releaser check-links --help

Checklist for Adoption

A. Prep the jupyter_releaser fork:

Clone this repository onto your GitHub user account.
Add a GitHub Access token with access to target GitHub repo to run GitHub Actions, saved as ADMIN_GITHUB_TOKEN in the repository secrets.
Add access token for the PyPI registry stored as PYPI_TOKEN. Note For security reasons, it is recommended that you scope the access to a single repository, and use a variable called PYPI_TOKEN_MAP that is formatted as follows:
```
```
owner1/repo1,token1
owner2/repo2,token2
```
```
If needed, add access token for npm, saved as NPM_TOKEN.

B. Prep target repository:

Switch to Markdown Changelog
- We recommend MyST, especially if some of your docs are in reStructuredText.
- Can use pandoc -s changelog.rst -o changelog.md and some hand edits as needed.
- Note that directives can still be used
Add HTML start and end comment markers to Changelog file - see example in CHANGELOG.md (view in raw mode)
Add tbump support if using Python - see example metadata in pyproject.toml
- We recommend putting setuptools metadata in setup.cfg and using version attr: <package_name>.__version__, see example setup.cfg
- See documentation on setup.cfg metadata
- If previously providing version_info, use a snippet like the one below, since tbump requires the intact version string, e.g.

import re

# Version string must appear intact for tbump versioning
__version__ = '1.4.0.dev0'

# Build up version_info tuple for backwards compatibility
pattern = r'(?P<major>\d+).(?P<minor>\d+).(?P<patch>\d+)(?P<rest>.*)'
match = re.match(pattern, __version__)
parts = [int(match[part]) for part in ['major', 'minor', 'patch']]
if match['rest']:
  parts.append(match['rest'])
version_info = tuple(parts)

Add a GitHub Actions CI step to run the check_release action. For example:

- name: Check Release
  if: ${{ matrix.python-version == '3.9' }}
  uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v1
  with:
    token: ${{ secrets.GITHUB_TOKEN }}

Note The check release action needs contents: write permission.

If you would like the release assets to be uploaded as artifacts, add the following step after the check_release action:

- name: Upload Distributions
  uses: actions/upload-artifact@v2
  with:
    name: jupyter-releaser-dist-${{ github.run_number }}
    path: .jupyter_releaser_checkout/dist

Update or add RELEASE.md that describes the onboarding and release process, e.g.

# Release Workflow

- [ ] Set up a fork of `jupyter-releaser` if you have not yet done so.
- [ ] Run through the release process, targeting this repo and the appropriate branch

Optionally add configuration to the target repository if non-standard options or hooks are needed.
If desired, add check_release job, changelog, and tbump support to other active release branches
Try out the Draft Changelog and Draft Release process against a fork of the target repo first so you don't accidentally push tags and GitHub releases to the source repository.
Try the Publish Release process using a prerelease version before publishing a final version.

Backport Branches

Create backport branches the usual way, e.g. git checkout -b 3.0.x v3.0.1; git push origin 3.0.x
When running the Publish Release Workflow, an automatic PR is generated for the default branch in the target repo, positioned in the appropriate place in the changelog.

Workflows

Detailed workflows are available to draft a changelog, draft a release, publish a release, and check a release.

Draft ChangeLog Workflow

Manual Github workflow
- Inputs are the target repo, branch, and the version spec
Bumps the version
- By default, uses tbump or bump2version to bump the version based on presence of config files
  - We recommend tbump instead of bump2version for most cases because it does not handle patch releases well when using prereleases.
Prepares the environment
- Sets up git config and branch
Generates a changelog (using github-activity) using the PRs since the last tag on this branch.
- Gets the current version and then does a git checkout to clear state
- Adds a new version entry using a HTML comment markers in the changelog file
- Optionally resolves meeseeks backport PRs to their original PR
Creates a PR with the changelog changes
Can be re-run using the same version spec. It will add new entries but preserve existing ones (in case they have been hand modified).
Note: Pre-release changelog sections are not automatically combined, but you may wish to do so manually.

Draft Release Workflow

Manual Github workflow
- Inputs are target repository, branch, version spec and optional post version spec
Bumps version using the same method as the changelog action
Prepares the environment using the same method as the changelog action
Checks the changelog entry
- Looks for the current entry using the HTML comment markers
- Gets the expected changelog values using github-activity
- Ensures that all PRs are the same between the two
For Python packages:
- Builds the wheel and source distributions if applicable
- Makes sure Python dists can be installed and imported in a virtual environment
For npm package(s) (including workspace support):
- Builds tarball(s) using npm pack
- Make sure tarball(s) can be installed and imported in a new npm package
Checks the package manifest using check-manifest
Checks the links in Markdown and reStructuredText files
Adds a commit that includes the hashes of the dist files
Creates an annotated version tag in standard format
If given, bumps the version using the post version spec
Pushes the commits and tag to the target branch
Publishes a draft GitHub release for the tag with the changelog entry as the text

Publish Release Workflow

Manual Github workflow
- Input is the url of the draft release
Downloads the dist assets from the release
Verifies shas and integrity of release assets
Publishes assets to appropriate registries
If the tag is on a backport branch, makes a forwardport PR for the changelog entry

Check Release Workflow

Runs on CI in the target repository to verify compatibility and release-ability.
Runs the Draft Changelog and Draft Release actions in dry run mode
Publishes to the local PyPI server and/or dry-run npm publish.
Does not make PRs or push git changes

FAQs

My changelog is out of sync

Create a new manual PR to fix the PR and re-orient the changelog entry markers.

PR is merged to the target branch in the middle of a "Draft Release"

The release will fail to push commits because it will not be up to date. Delete the pushed tags and re-start with "Draft Changelog" to pick up the new PR.

How to keep fork of Jupyter Releaser up to date

The manual workflow files target the @v1 actions in the source repository, which means that as long as the workflow files themselves are up to date, you will always be running the most up to date actions.

kevin-bates/jupyter_releaser