Skip to content

Update release-notes.R to bump version fields at release time#1944

Merged
cderv merged 1 commit intomainfrom
feature/release-notes-version-bump
Mar 6, 2026
Merged

Update release-notes.R to bump version fields at release time#1944
cderv merged 1 commit intomainfrom
feature/release-notes-version-bump

Conversation

@cderv
Copy link
Collaborator

@cderv cderv commented Mar 6, 2026

Extends tools/release-notes.R to automatically update version in both _quarto.yml and _quarto-prerelease-docs.yml during the release process.

Context

PR #1939 added a version field to these files for the prerelease-docs-url shortcode, which compares the version argument to _quarto.yml version to decide whether blog links go to quarto.org or prerelease.quarto.org. For this to work on main, _quarto.yml version must be bumped at release time.

Since release-notes.R runs on the prerelease branch, the version bump propagates to main when prerelease is merged.

What this does

At the end of the script, after updating the download listings:

  • _quarto.yml version → released version (e.g. '1.9')
  • _quarto-prerelease-docs.yml version → next prerelease (e.g. '1.10')

This replaces what was previously a manual step in the release checklist. A companion PR to quarto-cli updates the release checklist accordingly.

Extends the release notes script to also update `version` in
`_quarto.yml` (to the released version) and `_quarto-prerelease-docs.yml`
(to the next prerelease). This automates the version bump that was
previously a manual step, ensuring the `prerelease-docs-url` shortcode
resolves blog post links correctly after merge to main.
@cderv
Copy link
Collaborator Author

cderv commented Mar 6, 2026

Companion PR: quarto-dev/quarto-cli#14169 (updates the release checklist)

@cderv cderv requested a review from cwickham March 6, 2026 13:58
@github-actions github-actions bot temporarily deployed to pull request March 6, 2026 14:03 Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

📝 Preview Deployment

🔍 Full site preview: https://deploy-preview-1944.quarto.org

Copy link
Collaborator

@cwickham cwickham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@cderv cderv merged commit 4a9e378 into main Mar 6, 2026
4 checks passed
@cderv cderv deleted the feature/release-notes-version-bump branch March 6, 2026 20:00
github-actions bot pushed a commit that referenced this pull request Mar 6, 2026
Extends the release notes script to also update `version` in
`_quarto.yml` (to the released version) and `_quarto-prerelease-docs.yml`
(to the next prerelease). This automates the version bump that was
previously a manual step, ensuring the `prerelease-docs-url` shortcode
resolves blog post links correctly after merge to main.

(cherry picked from commit 4a9e378)
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

Successfully created backport PR for prerelease:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants