Skip to content

Clean up release instructions and coverage handling #1098

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.

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

Merged
merged 1 commit into from
Nov 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 4 additions & 6 deletions RELEASE.md
Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change
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