Skip to content
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

docs: update release instruction #260

Merged
merged 11 commits into from
Dec 29, 2023
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
17 changes: 0 additions & 17 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,6 @@ repos:
- id: prettier
types_or: [yaml, html, json]

- repo: https://github.com/adamchainz/blacken-docs
rev: "1.16.0"
hooks:
- id: blacken-docs
additional_dependencies: [black==23.7.0]
exclude: |
(?x)^(
doc/source/index.rst|
tests/test_execute.py
)$(|)

- repo: https://github.com/codespell-project/codespell
rev: "v2.2.6"
hooks:
Expand All @@ -68,9 +57,3 @@ repos:
args: ["--fix", "--show-fixes"]
- id: ruff-format
types_or: [python, jupyter]

- repo: https://github.com/scientific-python/cookie
rev: "2023.10.27"
hooks:
- id: sp-repo-review
additional_dependencies: ["repo-review[cli]"]
6 changes: 3 additions & 3 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.8"
python: "3.10"
sphinx:
configuration: doc/source/conf.py
configuration: docs/conf.py
python:
install:
# install itself with pip install .
- method: pip
path: .
extra_requirements:
Expand Down
14 changes: 3 additions & 11 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ To cut a new Jupyter Sphinx release, follow these steps:
- Ensure that all tests are passing on master.

- In [`_version.py`](https://github.com/jupyter/jupyter-sphinx/blob/main/jupyter_sphinx/_version.py),
change the "release type" section to "final" e.g.:
update the version number:

```python
version_info = (0, 2, 3, "final")
__version__ = "0.2.3"
```

- Make a release commit and push to main
Expand All @@ -24,19 +24,11 @@ To cut a new Jupyter Sphinx release, follow these steps:

- [Create a new github release](https://github.com/jupyter/jupyter-sphinx/releases/new).
The target should be **main**, the tag and the title should be the version number,
e.g. `0.2.3`.
e.g. `v0.2.3`.

- Creating the release in GitHub will push a tag commit to the repository, which will
trigger [a GitHub action](https://github.com/jupyter/jupyter-sphinx/blob/main/.github/workflows/artifacts.yml)
to build `jupyter-sphinx` and push the new version to PyPI.
[Confirm that the version has been bumped](https://pypi.org/project/jupyter-sphinx/).

- In [`_version.py`](https://github.com/jupyter/jupyter-sphinx/blob/main/jupyter_sphinx/_version.py),
bump the minor version and change the "release type" section to "alpha". **make sure to
include a number after the release type**, e.g.:

```python
version_info = (0, 2, 4, "alpha", 1)
```

- That's it!
26 changes: 0 additions & 26 deletions doc/Makefile

This file was deleted.

37 changes: 0 additions & 37 deletions doc/source/conf.py

This file was deleted.

Loading