-
Notifications
You must be signed in to change notification settings - Fork 331
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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]>
- Loading branch information
Showing
2 changed files
with
38 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Release instructions | ||
|
||
This page contains the steps to make a release and some helpful resources to get you started. | ||
|
||
Create an issue and copy/paste the steps below to release a new version. Close the issue when it is done. | ||
|
||
These steps should be taken in order to create a new release![^release-refs] | ||
|
||
```md | ||
**Double check for quality-control** | ||
|
||
- [ ] There are no [open issues with a `impact: block-release` label](https://github.com/pydata/pydata-sphinx-theme/labels/impact%3A%20block-release) | ||
|
||
**Prepare the codebase for a new version** | ||
|
||
- [ ] Bump `__version__` in [`__init__.py`](https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/__init__.py#L16) | ||
- [ ] Update our [version switcher `.json` file](https://github.com/pydata/pydata-sphinx-theme/blob/main/docs/_static/switcher.json) with the new version | ||
- [ ] Make a release commit: `git commit -m 'bump: 0.1.9 → 0.2.0'` | ||
- [ ] Push the RLS commit `git push upstream main` | ||
- [ ] If a **release candidate** is needed, tick this box when we're now ready for a full release. | ||
|
||
**Make the release** | ||
|
||
- [ ] [Start a new GitHub release](https://github.com/pandas-dev/pydata-sphinx-theme/releases/new) | ||
- Call the release the current version, e.g. `v0.2.0` | ||
- In the **`Choose a Tag:`** dropdown, type in the release name (e.g., `v0.2.0`) and click "Create new tag" | ||
- In the **`Target:`** dropdown, pin it to the release commit that you've just pushed. | ||
- Generate the automatic release notes, eventually manually specify the previous version (useful when several release candidate have been made) | ||
- [ ] Confirm that the release completed | ||
- [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). | ||
- [The PyPI version is updated](https://pypi.org/project/pydata-sphinx-theme/) | ||
- [ ] Hide the previous patch version build in the RDT interface if needed. | ||
- [ ] Celebrate, you're done! | ||
|
||
[^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. | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters