Skip to content

DEMO: New release scripts & notebooks! #611

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

Closed
wants to merge 170 commits into from
Closed

Conversation

validbeck
Copy link
Collaborator

@validbeck validbeck commented Dec 28, 2024

Internal Notes for Reviewers

Demonstration of the functionality added in #607 and #610.

Year end cleanup

View demo run

Try it yourself

  1. Grab this branch locally: gh pr checkout 611
  2. Open up release-scripts/year-end-cleanup.ipynb.
  3. Run the notebook and enter in 2025 when the year input dialogue prompts you.
  4. See the magic happen:
  • New 2025 directory created
  • 2025 releases moved into that new directory
  • New 2025-releases.qmd page created with the moved releases as listings
Screenshot 2024-12-27 at 4 41 27 PM
  • New accordion folder for 2025 in "About > Releases"
Before After
Screenshot 2024-12-27 at 3 20 44 PM Screenshot 2024-12-27 at 4 37 02 PM
  • In _quarto.yml the # CURRENT-YEAR-END-MARKER will be moved to above your 2025 releases but BELOW the fake 2026 release
Before After
Screenshot 2024-12-27 at 4 38 21 PM Screenshot 2024-12-27 at 4 37 22 PM
  • Resolution of any broken absolute links to the moved release pages
    Screenshot 2024-12-27 at 4 41 45 PM
  • Notebook will returns a list of relative filepaths within the moved release pages that may need to be adjusted — I added some just for funsies!
    Screenshot 2024-12-27 at 4 41 54 PM
  • Notebook shows you the list of files to be committed, omitting the changes in the release-scripts folder

Screenshot 2024-12-27 at 4 45 26 PM

  • A preview using Quarto will run

Generate release notes

I ran the new release notebook and Make command.

Old notebook output New notebook output
View old demo run View new demo run
Screenshot 2024-12-27 at 3 20 50 PM
  • And it also automagically appends our single-sourced "How to upgrade" at the bottom of the release files!
Screenshot 2024-12-27 at 4 34 31 PM

@validbeck validbeck added the internal Not to be externalized in the release notes label Dec 28, 2024
@validbeck validbeck self-assigned this Dec 28, 2024
@validbeck validbeck force-pushed the beck/demo-release-scripts branch from c19f258 to 024037e Compare December 28, 2024 00:21
@validbeck validbeck added the DO NOT MERGE PR is not ready to be merged label Dec 28, 2024
Copy link
Contributor

A PR preview is available: Preview URL

1 similar comment
Copy link
Contributor

A PR preview is available: Preview URL

@nrichers nrichers self-requested a review January 7, 2025 00:20
@validbeck validbeck closed this Jan 15, 2025
@validbeck validbeck deleted the beck/demo-release-scripts branch March 25, 2025 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DO NOT MERGE PR is not ready to be merged internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant