Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More detailed release instructions #1959

Merged
merged 2 commits into from
Mar 16, 2023
Merged

More detailed release instructions #1959

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a2b8ec
More details release instructions.
Carreau Mar 14, 2023
28f5ad1
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,15 @@

The recommended way to make a release is to use [`jupyter_releaser`](https://github.com/jupyter-server/jupyter_releaser) from this repository.

- Run the "Step 1: Prep Release" workflow with the appropriate inputs.
- Review the changelog in the draft GitHub release created in Step 1.
- Run the "Step 2: Publish Release" workflow to finalize the release.
- Run the ["Step 1: Prep Release"](https://github.com/jupyter/nbconvert/actions/workflows/prep-release.yml) workflow with the appropriate inputs.
- You can usually use the following values for the workflow:
- branch : 'main' when releasing fro teh main branch
- "Post Version Specifier" empty unless you do a beta or rc release
- keep `since_last_stable` unchecked
- "Use PRs with activity since this date or git reference"
- Review the changelog in the [draft GitHub release](https://github.com/jupyter/nbconvert/releases) created in Step 1.
- You will need the URL to the created draft release in the form `https://github.com/jupyter/nbconvert/releases/tag/<something>-<some-numbers>` for next step.
- Run the ["Step 2: Publish Release"](https://github.com/jupyter/nbconvert/actions/workflows/publish-release.yml) workflow to finalize the release.

## Manual Release

Expand Down