Skip to content

Commit

Permalink
Clean up release instructions and coverage handling (#1098)
Browse files Browse the repository at this point in the history
  • Loading branch information
blink1073 committed Nov 27, 2022
1 parent a50dd7c commit 3136aac
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
10 changes: 4 additions & 6 deletions RELEASE.md
Expand Up @@ -2,7 +2,7 @@

## Using `jupyter_releaser`

The recommended way to make a release is to use [`jupyter_releaser`](https://github.com/jupyter-server/jupyter_releaser#checklist-for-adoption).
The recommended way to make a release is to use [`jupyter_releaser`](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html).

Note that we must use manual versions since Jupyter Releaser does not
yet support "next" or "patch" when dev versions are used.
Expand All @@ -14,19 +14,17 @@ To create a manual release, perform the following steps:
### Set up

```bash
pip install hatchling twine build
pip install hatch twine build
git pull origin $(git branch --show-current)
git clean -dffx
npm install
npm run build
```

### Update the version and apply the tag

```bash
echo "Enter new version"
read new_version
hatchling version ${new_version}
hatch version ${new_version}
git tag -a ${new_version} -m "Release ${new_version}"
```

Expand All @@ -42,7 +40,7 @@ python -m build .
```bash
echo "Enter dev version"
read dev_version
hatchling version ${dev_version}
hatch version ${dev_version}
git push origin $(git branch --show-current)
```

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Expand Up @@ -100,9 +100,9 @@ nowarn = "test -W default {args}"

[tool.hatch.envs.cov]
features = ["test"]
dependencies = ["coverage", "pytest-cov"]
dependencies = ["coverage[toml]"]
[tool.hatch.envs.cov.scripts]
test = "python -m pytest -vv --cov jupyter_server --cov-branch --cov-report term-missing:skip-covered {args}"
test = "coverage run -m pytest {args}"
nowarn = "test -W default {args}"
integration = "test --integration_tests=true {args}"

Expand Down

0 comments on commit 3136aac

Please sign in to comment.