Skip to content

Commit ac4f14d

Browse files
authored
Merge pull request #1434 from choldgraf/release-docs
Simplify our release docs
2 parents a55f54b + 0b12f5f commit ac4f14d

File tree

1 file changed

+13
-34
lines changed

1 file changed

+13
-34
lines changed

docs/source/contribute/tasks.md

Lines changed: 13 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -112,47 +112,26 @@ See the subsections below for more detailed instructions.
112112

113113
## Creating a Release
114114

115-
We make a release of whatever is on `main` every month. We use "calendar versioning".
116-
Monthly releases give users a predictable pattern for when releases are going to
117-
happen and prevents locking up improvements for fixes for long periods of time.
115+
We encourage a release of whatever is on `main` every month. We use "[calendar versioning](https://calver.org/)".
118116

119117
A new release will automatically be created when a new git tag is created
120-
and pushed to the repository.
118+
and pushed to the repository. See [previous releases](https://github.com/jupyterhub/repo2docker/releases) for examples.
121119

122120
To create a new release, follow these steps:
123121

124-
### Create a new tag and push it
122+
- Go to the [GitHub repository](https://github.com/jupyterhub/repo2docker)
123+
- Click `Draft a new release`
124+
- Click `Tag`
125+
- Type in a new tag like `YYYY.MM.N` (where `N` is the release number this month, usually it is `0`)
126+
- Title: `<Month> <Year>` (E.g., `August 2025`)
127+
- Body: Paste the output of `github-activity` since the date of the last release.
128+
- E.g. `github-activity jupyterhub/repo2docker -s 2025-08-01
129+
- Click `Publish release`
125130

126-
First, tag a new release locally:
131+
This will create a new release **and a new tag**.
132+
The creation of the tag will trigger the `.github/workflows/release.yml` action to publish the latest repo2docker package to PyPI.
127133

128-
```bash
129-
V=YYYY.MM.0; git tag -am "release $V" $V
130-
```
131-
132-
> If you need to make a second (or third) release in a month increment the
133-
> trailing 0 of the version to 1 (or 2).
134-
135-
Then push this change up to the main repository
136-
137-
```
138-
git push origin --tags
139-
```
140-
141-
GitHub Actions should create a
142-
new release on the [repo2docker PyPI](https://pypi.org/project/jupyter-repo2docker/).
143-
Once this has completed, make sure that the new version has been updated.
144-
145-
### Create a new release on the GitHub repository
146-
147-
Once the new release has been pushed to PyPI, we need to create a new
148-
release on the [GitHub repository releases page](https://github.com/jupyterhub/repo2docker/releases). Once on that page, follow these steps:
149-
150-
- Click "Draft a new release"
151-
- Choose a tag version using the same tag you just created above
152-
- The release name is simply the tag version
153-
- Finally, click "Publish release"
154-
155-
That's it!
134+
You can confirm the new package is released [in our PyPI page](https://pypi.org/project/jupyter-repo2docker/#history).
156135

157136
# Uncommon tasks
158137

0 commit comments

Comments
 (0)