Skip to content

Commit 0f652e1

Browse files
authored
Update Zenodo info & correct a small typo (#7191)
* Correct the Zenodo info The Zenodo releases now get created automatically, so the step about Zenodo only needs to say that the info should be checked. * Fix typo (wrong variable name) * Add a few missing `main` formatting codes * Remove text about changelog in cirq-google There is no such changelog. * Make a section title more clear
1 parent c3d315e commit 0f652e1

File tree

1 file changed

+13
-22
lines changed

1 file changed

+13
-22
lines changed

release.md

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ releases.
66
Note that Cirq development takes place on the `main` branch in GitHub. If you
77
want to use a more stable version of Cirq, you should use one of the
88
[releases](https://github.com/quantumlib/Cirq/releases) or install the package
9-
from PyPI using `pip install cirq`. The release from the latest commit to main
9+
from PyPI using `pip install cirq`. The release from the latest commit to `main`
1010
can be installed with `pip install cirq~=1.0.dev`.
1111

1212
## Versioning
@@ -141,7 +141,7 @@ NEXT_VER=NEXT_VERSION # e.g. "0.8.0" (skip for PATCH releases)
141141

142142
### Create a release branch
143143

144-
Create a release branch called "v${VERSION}-dev":
144+
Create a release branch called "v${VER}-dev":
145145

146146
```bash
147147
git checkout -b "v${VER}-dev"
@@ -166,7 +166,7 @@ git push origin "v${VER}-dev"
166166

167167
### Bump the main version
168168

169-
WARNING: Only bump the main version for minor and major releases. For PATCH
169+
WARNING: Only bump the `main` version for minor and major releases. For PATCH
170170
updates, leave it as it is.
171171

172172
```bash
@@ -177,9 +177,9 @@ git commit -m "Bump cirq version to ${NEXT_VER}"
177177
git push origin "version_bump_${NEXT_VER}"
178178
```
179179

180-
The main branch should never see a non-dev version specifier.
180+
The `main` branch should never see a non-dev version specifier.
181181

182-
### Create distribution wheel
182+
### Create the distribution wheel
183183

184184
From a release branch, create a binary distribution wheel. This is the package
185185
that will go to PyPI.
@@ -259,11 +259,6 @@ git log <previous version>..HEAD --pretty="%an" | sort |\
259259
uniq | sed ':a;N;$!ba;s/\n/, /g'
260260
```
261261

262-
### `cirq-google` Changelog
263-
264-
Add `cirq-google` release notes to `cirq-google/CHANGELOG.md` following the
265-
[changelog format](https://keepachangelog.com/en/1.0.0/).
266-
267262
### Release to production PyPI
268263

269264
Upload to prod PyPI using the following command:
@@ -289,7 +284,7 @@ pip install cirq
289284
python -c "import cirq; print(cirq.__version__)"
290285
```
291286

292-
### Create the release
287+
### Create the release on GitHub
293288

294289
Using the information above, create the release on the
295290
[Release page](https://github.com/quantumlib/Cirq/releases).
@@ -302,18 +297,14 @@ If there are unreleased notebooks that are under testing (meaning that
302297
[`dev_tools/notebooks/isolated_notebook_test.py`](dev_tools/notebooks/isolated_notebook_test.py)),
303298
then follow the steps in our [notebooks guide](docs/dev/notebooks.md).
304299

305-
### Create a Zenodo release
306-
307-
Got to the [Zenodo release
308-
page](https://zenodo.org/record/6599601#.YpZCspPMLzc). Login using credentials
309-
stored in Google's internal password utility (or get someone from Google to do
310-
this). Click "New Version".
300+
### Verify the Zenodo archive
311301

312-
* Upload the new zip file (found in releases page under "assets").
313-
* Remove old zip file.
314-
* Update version.
315-
* Double check all other fields.
316-
* Click publish.
302+
Each new release should get archived in Zenodo automatically. To check it, [log
303+
in to Zenodo](https://zenodo.org) using credentials stored in Google's internal
304+
password utility (or get someone from Google to do this). Navigate to the [list
305+
of uploads](https://zenodo.org/me/uploads), and ensure an entry for the new
306+
release is present there. Open the page for the entry, verify the information,
307+
and edit it if necessary.
317308

318309
### Email cirq-announce
319310

0 commit comments

Comments
 (0)