Skip to content

Commit b9e013e

Browse files
authored
Update release checklist for version-aware shortcode fields (#14169)
- Note that release-notes.R now bumps version fields automatically - Add verification step after prerelease→main merge - Replace manual version bump step with verification
1 parent d6e3f05 commit b9e013e

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,19 @@
3232
- [ ] change `docs/prerelease/_highlights.qmd` so its include points to the new version-specific `_highlights.qmd` file (here, 1.5)
3333
- [ ] change `docs/prerelease/_highlights-release.qmd` so its include points to the new version-specific `_highlights.qmd` file (here, 1.4)
3434
- [ ] add the stable version to the older downloads list by editing /docs/download/\_download-older.yml
35-
- [ ] run `quarto run tools/release-notes.R` to generate the release notes
35+
- [ ] run `quarto run tools/release-notes.R` to generate the release notes and bump `version` in `_quarto.yml` (to released version) and `_quarto-prerelease-docs.yml` (to next prerelease)
3636
- [ ] push the changes to `prerelease` branch, ensure they build correctly
3737
- [ ] Merge the `prerelease` branch into `main`, push to `main`
3838
- [ ] ensure the build completes successfully
39+
- [ ] verify `_quarto.yml` `version` on `main` reflects the released version (e.g. `'1.4'`) — needed for `prerelease-docs-url` shortcode to resolve blog links to quarto.org
3940
- [ ] Merge `main` into `prerelease`, push to `prerelease`
4041
- [ ] ensure the build completes successfully
4142
- [ ] Create new tag on `main` with stable release version number (here, `v1.4`) to mark when the new main site version went live
4243
- [ ] `git tag -a v1.4 -m "v1.4"`
4344
- [ ] `git push origin v1.4`
44-
- [ ] Update `prerelease` version number (here, `v1.5`)
45-
- [ ] edit `_quarto-prerelease-docs.yml` to point to the new version
45+
- [ ] Verify version numbers were updated by `tools/release-notes.R`
46+
- [ ] `_quarto.yml` `version` should be the released version (e.g. `'1.4'`)
47+
- [ ] `_quarto-prerelease-docs.yml` `version` should be the next prerelease (e.g. `'1.5'`)
4648
- [ ] publish the release blog post that should exist in https://github.com/quarto-dev/quarto-web/tree/main/docs/blog/posts
4749
- [ ] Create a branch off of `main` (to trigger our PR automation to make the corresponding change to `prerelease`).
4850
- [ ] Removing the `draft: true` line in the metadata

0 commit comments

Comments
 (0)