-
Notifications
You must be signed in to change notification settings - Fork 339
fix: move the release instructions to the repository #1621
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
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f8a1e5a
fix: update text and links
12rambau 69d7a55
fix: add code highlight
12rambau a76fee6
fix: wire correct file in our documentation
12rambau 4e094e7
chore: trigger CI
12rambau 3a0f311
remove mention of semantic versioning
12rambau 3029360
refactor: lint
12rambau c1ef152
Update RELEASE.md
12rambau File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 in our wiki](https://github.com/pydata/pydata-sphinx-theme/wiki/Release-checklist). See [the release documentation](https://pydata-sphinx-theme.readthedocs.io/en/latest/contribute/policies.html#release-policy) for an overview of release processes. | ||
12rambau marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` |
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that having two locations for roughly the same list of information will mean one of them goes out-of-date and we create confusion about which process should be followed. I'd suggest either:
RELEASE.md
and just providing a link to the wiki pageThat way there's a single source of truth. Does that make sense?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That makes sense 👍 - we'd already discussed moving this to the release.md file and get rid of the wiki (this was the only content in there).