diff --git a/RELEASE.md b/RELEASE.md index e54c5dcce..16328a9be 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -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/-` 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