Skip to content

Commit f50e7b9

Browse files
12rambaudrammock
andauthored
fix: move the release instructions to the repository (#1621)
* fix: update text and links * fix: add code highlight * fix: wire correct file in our documentation * chore: trigger CI * remove mention of semantic versioning Co-authored-by: Daniel McCloy <[email protected]> * refactor: lint * Update RELEASE.md --------- Co-authored-by: Daniel McCloy <[email protected]>
1 parent 2057612 commit f50e7b9

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

RELEASE.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Release instructions
2+
3+
This page contains the steps to make a release and some helpful resources to get you started.
4+
5+
Create an issue and copy/paste the steps below to release a new version. Close the issue when it is done.
6+
7+
These steps should be taken in order to create a new release![^release-refs]
8+
9+
```md
10+
**Double check for quality-control**
11+
12+
- [ ] There are no [open issues with a `impact: block-release` label](https://github.com/pydata/pydata-sphinx-theme/labels/impact%3A%20block-release)
13+
14+
**Prepare the codebase for a new version**
15+
16+
- [ ] Bump `__version__` in [`__init__.py`](https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/__init__.py#L16)
17+
- [ ] Update our [version switcher `.json` file](https://github.com/pydata/pydata-sphinx-theme/blob/main/docs/_static/switcher.json) with the new version
18+
- [ ] Make a release commit: `git commit -m 'bump: 0.1.9 → 0.2.0'`
19+
- [ ] Push the RLS commit `git push upstream main`
20+
- [ ] If a **release candidate** is needed, tick this box when we're now ready for a full release.
21+
22+
**Make the release**
23+
24+
- [ ] [Start a new GitHub release](https://github.com/pandas-dev/pydata-sphinx-theme/releases/new)
25+
- Call the release the current version, e.g. `v0.2.0`
26+
- In the **`Choose a Tag:`** dropdown, type in the release name (e.g., `v0.2.0`) and click "Create new tag"
27+
- In the **`Target:`** dropdown, pin it to the release commit that you've just pushed.
28+
- Generate the automatic release notes, eventually manually specify the previous version (useful when several release candidate have been made)
29+
- [ ] Confirm that the release completed
30+
- [The `publish` github action job](https://github.com/pydata/pydata-sphinx-theme/blob/main/.github/workflows/publish.yml#L31) has completed successfully in the [actions tab](https://github.com/pydata/pydata-sphinx-theme/actions).
31+
- [The PyPI version is updated](https://pypi.org/project/pydata-sphinx-theme/)
32+
- [ ] Hide the previous patch version build in the RDT interface if needed.
33+
- [ ] Celebrate, you're done!
34+
35+
[^release-refs]: Taken from [the release checklist](https://github.com/pydata/pydata-sphinx-theme/blob/main/RELEASE.md). See [the release documentation](https://pydata-sphinx-theme.readthedocs.io/en/latest/contribute/policies.html#release-policy) for an overview of release processes.
36+
```

docs/community/practices/release.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Anybody is encouraged to make a new release if:
1919

2020
- It has been more than a month since the last release.
2121
- OR a significant change has been made to our code that warrants a release.
22-
- AND there are no open issues with a [{guilabel}`block-release`](https://github.com/pydata/pydata-sphinx-theme/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Ablock-release) label.
22+
- AND there are no open issues with a [{guilabel}`impact: block-release`](https://github.com/pydata/pydata-sphinx-theme/labels/impact%3A%20block-release) label.
2323

2424
### Release candidates
2525

@@ -35,7 +35,7 @@ Follow these steps to make a release:
3535

3636
- (optionally) **Create a [GitHub milestones](https://github.com/pydata/pydata-sphinx-theme/milestones)** to organize the issues that should be resolved as part of a new release.
3737
- **Decide if it's time** to make a release be reading [](releases:when) and decide if it is time for a release.
38-
- **Copy the release checklist into a new issue**. We have [a release checklist in our wiki](https://github.com/pydata/pydata-sphinx-theme/wiki/Release-checklist#release-instructions).
38+
- **Copy the [release checklist](https://github.com/pydata/pydata-sphinx-theme/blob/main/RELEASE.md) into a new issue**.
3939
- **Complete the checklist**. That's it!
4040

4141
## Choosing a version increment

0 commit comments

Comments
 (0)