Skip to content

Commit 7cfbe4c

Browse files
committed
checklist updates
1 parent 872eaf8 commit 7cfbe4c

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

dev-docs/checklist-make-a-new-quarto-release.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,21 @@
22
- [ ] create a branch `v1.x`, where x is the version being released
33
- `git checkout -b v1.4`
44
- `git push origin v1.4`
5-
- [ ] mark the current release as the stable release in the `main` branch
5+
- [ ] mark the current release as the new release in the `main` branch
66
- [ ] edit QUARTO_VERSION line in `/configuration` to be the new version (e.g. `1.5`)
77
- [ ] push the changes to the `main` branch
88
- [ ] kick off a v1.5 build in GHA: https://github.com/quarto-dev/quarto-cli/actions/workflows/create-release.yml
99
- [ ] ensure the build completes successfully
1010
- [ ] mark v1.4 release as stable
11-
- go to https://github.com/quarto-dev/quarto-cli/releases
12-
- find the latest v1.4 release and edit, (eg https://github.com/quarto-dev/quarto-cli/releases/edit/v1.4.549)
13-
- at the bottom of the page, there will be two checkboxes, "Set as pre-release" and "Set as latest release":
14-
- "Set as pre-release" should be unchecked, and
15-
- "Set as latest release" should be checked.
11+
- [ ] go to https://github.com/quarto-dev/quarto-cli/releases
12+
- [ ] find the latest v1.4 release and edit, (eg https://github.com/quarto-dev/quarto-cli/releases/edit/v1.4.549)
13+
- [ ] at the bottom of the page, there will be two checkboxes, "Set as pre-release" and "Set as latest release":
14+
- [ ] "Set as pre-release" should be unchecked, and
15+
- [ ] "Set as latest release" should be checked.
1616
- [ ] once the v1.5 build completes, edit the quarto.org website configuration on https://github.com/quarto-dev/quarto-web to reflect the new version
1717
- this means flipping the profile group configuration in `_quarto.yml` from `[rc,prelease]` to `[prerelease,rc]`
1818
- [ ] push the changes to the `main` branch
1919
- [ ] quarto-dev/quarto-web changes
20-
2120
- wait for the downloads file to be automatically updated by the GitHub Action on https://github.com/quarto-dev/quarto-web
2221
- [ ] wait for https://github.com/quarto-dev/quarto-web/actions/workflows/update-downloads.yml to run (it runs every 15 minutes, or you can manually trigger it)
2322
- This workflow run rendered the website: https://github.com/quarto-dev/quarto-web/actions/runs/12016407762
@@ -30,20 +29,22 @@
3029
- [ ] create `docs/prerelease/1.5/{_highlights, index, _pre-release-feature}.qmd` files based on the ones from the previous release
3130
- [ ] change `docs/prerelease/_highlights.qmd` so its include points to the new version-specific `_highlights.qmd` file (here, 1.5)
3231
- [ ] change `docs/prerelease/_highlights-release.qmd` so its include points to the new version-specific `_highlights.qmd` file (here, 1.4)
33-
- [ ] add the stable version to the older downloads list, like [this example](https://github.com/quarto-dev/quarto-web/commit/85ef62ec5036026d62d57f9cfb190d8b923b2d43)
34-
- [ ] run `quarto run tools/release-notes.R` to generate the release notes
32+
- [ ] add the stable version to the older downloads list by editing /docs/download/_download-older.yml
33+
- [ ] run `quarto run tools/release-notes.R` to generate the release notes
3534
- [ ] push the changes to `prerelease` branch, ensure they build correctly
36-
- [ ] Merge the `prerelease` branch into `main`
35+
- [ ] Merge the `prerelease` branch into `main`, push to `main`
3736
- [ ] ensure the build completes successfully
38-
- [ ] Merge `main` into `prerelease`
37+
- [ ] Merge `main` into `prerelease`, push to `prerelease`
3938
- [ ] ensure the build completes successfully
4039
- [ ] Create new tag on `main` with stable release version number (here, `v1.4`) to mark when the new main site version went live
4140
- [ ] `git tag -a v1.4 -m "v1.4"`
4241
- [ ] `git push origin v1.4`
4342
- [ ] Update `prerelease` version number (here, `v1.5`)
4443
- [ ] edit `_quarto-prerelease-docs.yml` to point to the new version
4544
- [ ] publish the release blog post that should exist in https://github.com/quarto-dev/quarto-web/tree/main/docs/blog/posts
46-
by removing the `draft: true` line in the metadata and changing the date to match the release date. Do this on a branch off of `main` to trigger our PR automation to make the corresponding change to `prerelease`.
45+
- [ ] Create a branch off of `main` (to trigger our PR automation to make the corresponding change to `prerelease`).
46+
- [ ] Removing the `draft: true` line in the metadata
47+
- [ ] Change the date to match the release date.
4748

4849
- [ ] Update https://github.com/quarto-dev/quarto-cli/blob/main/CITATION.cff
4950
- [ ] Packaging and package managers, etc
@@ -55,8 +56,8 @@
5556
- Check the "Whether to publish or not the package on chocolatey" checkbox
5657
- Wait for @cderv to receive email confirmation, no action needed
5758
- [ ] pypi
58-
- Goto the [quarto-cli-pypi repo](https://github.com/quarto-dev/quarto-cli-pypi)
59-
- Update `version.txt` to be the version you'd like to publish and commit
59+
- Go to the [quarto-cli-pypi repo](https://github.com/quarto-dev/quarto-cli-pypi)
60+
- [ ] Update `version.txt` to be the version you'd like to publish and commit
6061
- Go to actions
6162
- Select 'Publish Quarto PyPi'
6263
- [ ] Click "Run Workflow"

0 commit comments

Comments
 (0)