1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
|
# Making an NBConvert Release
## Using `jupyter_releaser`
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"](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 from the 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
To create a manual release, perform the following steps:
### Set up
```bash
pip install pipx
git pull origin $(git branch --show-current)
git clean -dffx
```
### Update the version and apply the tag
```bash
echo "Enter new version"
read new_version
pipx run hatch version ${new_version}
git tag -a ${new_version} -m "Release ${new_version}"
```
### Build the artifacts
```bash
rm -rf dist
pipx run build .
```
### Publish the artifacts to pypi
```bash
pipx run twine check dist/*
pipx run twine upload dist/*
```
|
