Skip to content

Commit

Permalink
More detailed release instructions. (#1959)Co-authored-by: pre-commit…
Browse files Browse the repository at this point in the history
…-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* More details release instructions.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
Carreau and pre-commit-ci[bot] authored Mar 16, 2023
1 parent 565f9a2 commit 6f77b0b
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions RELEASE.md
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

0 comments on commit 6f77b0b

Please sign in to comment.