Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pages for release notes #1250

Merged
merged 1 commit into from
Jul 11, 2024
Merged

Add pages for release notes #1250

merged 1 commit into from
Jul 11, 2024

Conversation

cwickham
Copy link
Collaborator

@cwickham cwickham commented Jul 8, 2024

A rather manual take on having release notes in permanent locations on quarto.org of the form quarto.org/docs/download/changelog/1.*/ (e.g. 1.4).

Available via links from "Older Releases" tab. Current and prerelease are aliased to their respective pages.

We would have to add the following tasks to the release checklist:

  • Copy changelog from old release to _changelog.md in docs/download/changelog/1.x

  • Copy docs/download/changelog/1.*/index.qmd and increment versions

  • Add new item to download-older listing in docs/download/index.qmd

  • Increment version in aliases of:

    • docs/download/release.qmd
    • docs/download/prerelease.qmd

Would close quarto-dev/quarto-cli#5396

Copy link
Contributor

github-actions bot commented Jul 8, 2024

🚀 Deployed on https://deploy-preview-1250.quarto.org

@github-actions github-actions bot temporarily deployed to pull request July 8, 2024 18:34 Inactive
@cwickham cwickham marked this pull request as ready for review July 9, 2024 22:11
@cwickham cwickham requested a review from cderv July 9, 2024 22:11
@cwickham
Copy link
Collaborator Author

cwickham commented Jul 9, 2024

@cderv, this is a pretty manual approach but is designed to solve the issue of not having places on quarto.org for release notes. I imagine there are more automated approaches, but maybe a once a release edit isn't too bad?

@cderv
Copy link
Collaborator

cderv commented Jul 10, 2024

I think as long as we have the manual checklist for release this is ok.

Though we could also do simple automation:

  • Have a script (that we could also run with quarto run, to do exactly the step you mentioned (that also play the role of documentation)
  • I don't think having some CI automation for this is worth the effort and maintainance for once per version. At least until we'll do other manual step.

What do you think about the script ? 🤷‍♂️

@cwickham
Copy link
Collaborator Author

@cderv Yeah, a script could be good. So, the manual step becomes: run update-release-notes.sh, or something. Is this something we should do in this PR? Or should we merge this, then figure out the script?

I have a slight preference for earlier merging so I can link to the 1.5 release notes in the blog post I'm working on for this week.

@cderv
Copy link
Collaborator

cderv commented Jul 10, 2024

So, the manual step becomes: run update-release-notes.sh, or something.

Exactly. Though we could leverage quarto run command to write a script in R, python, lua, or typescript instead of .sh and the step would be

  • quarto run update-release-notes.R for example.

Like our update for reference pages once per version from script in tools/. That is my idea.

Is this something we should do in this PR? Or should we merge this, then figure out the script?

It is not necessary on this PR though one advantage:

  • You know the step you did know, so you could write the script
  • You can easily reset the state of the file from change in this PR, run the script and test it gets you exactly what you did manually.

But it can definitely be done later for next release. So if you prefer that, I would merge this one and open an issue with the idea. I could work on it later for quarto 1.6 release if you want

@cwickham
Copy link
Collaborator Author

I want to get the blog post out today anddon't have time for the script right now. So, I'll merge this and open an issue for the script.

Thanks for the feedback!

@cwickham
Copy link
Collaborator Author

Opened quarto-dev/quarto-cli#10277

@cwickham cwickham merged commit 91a36e0 into main Jul 11, 2024
4 checks passed
@cwickham cwickham deleted the issues/5396 branch July 11, 2024 17:11
Copy link
Contributor

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.

[Documentation] Render our release note file to HTML in quarto-web
2 participants