Edited release script & notebook#607
Edited release script & notebook#607validbeck merged 160 commits intomainvalidmind/documentation:mainfrom beck/sc-7068/releases-automatically-add-upgrade-info-insertvalidmind/documentation:beck/sc-7068/releases-automatically-add-upgrade-info-insertCopy head branch name to clipboard
Conversation
PR SummaryThis pull request introduces several enhancements and refactoring to the release notes generation process. The key changes include:
These changes aim to streamline the release notes generation process, reduce manual effort, and improve the maintainability of the codebase. Test Suggestions
|
|
A PR preview is available: Preview URL |
2 similar comments
|
A PR preview is available: Preview URL |
|
A PR preview is available: Preview URL |
|
A PR preview is available: Preview URL |
|
As discussed, I will test the functionality of this PR when I work on the release notes up to Sprint 66 which we now have a story for. I did take a look at the MANY changes you made here and I especially like that
Bravo all around! 🥇🥇🥇 |
Internal Notes for Reviewers
generate_release_objects.pymainfunction now performs all the same features as the notebook (for example,auto_summarywas previously missing)mainwe simply call the granular functions defined earlier in the script — much cleaner, and also if we need to edit any of the functions now we don't have to do it 2-3 timesgenerate-release-notes.ipynbgenerate_release_objects.pyin piecemeal, we simply import the whole script with an alias — "single-sourcing" at its finestSet up OpenAI API
.envfile (default is set to../.env)YOU CAN TEST THIS BY INPUTTING A FILEPATH WITH NO VALID .ENV OR REMOVE THE EXPECTED KEY FROM YOUR .ENV FILE
.envfile at locationSet labels > Create categories from labels
Write release notes to file
I updated this so that it automatically appends
{{< include /releases/_how-to-upgrade.qmd >}}to the file we created 🎉Update index
index.qmdin the "Latest Releases" sectionindex.qmdpage:The new function in the script:
Show files to commit
Here I modified the script so that it filters out the files changed in
release-scripts/:MakefileCalling
make release-notesnow callsgenerate_release_objects.py, checks thegit status, and provides a preview usingquarto preview(meaning it has the exact same functionality as the notebook, just through the command line):Create Release Notes
Since adding the upgrade information and slotting in the new release to the index is done automatically, I updated our internal Notion documentation: