Create make release-notes action #110
Conversation
There was a problem hiding this comment.
@sydneysugar kudos on another great PR! I did some preliminary testing and had some suggestions, but overall this PR is very much on the right track. Way to go! I'm also impressed that you were able to find your way around PRs in GitHub and create a first version of this rather important docs infrastructure. 🎉🎉🎉
site/generate_release_notes.py
Outdated
| formatted_release_date = datetime.strptime(release_date, "%B %d, %Y").strftime("%Y-%b-%d").lower() | ||
| file.write(f' - text: "{release_date}"\n') | ||
| file.write(f' contents:\n') | ||
| file.write(f' - text: "Release Highlights"\n') |
There was a problem hiding this comment.
When I tested your PR, I noticed that the script also generates a highlight.qmd file, alongside this parent release notes topic with the date in it. I would perhaps omit creating this extra file and putting the release highlights right into the file you're creating here.
Not sure if you can further subdivide highlights by section, e.g. place anything from the validmind-python repo right into the ### ValidMind Developer Framework section, and anything from the frontend into the ### ValidMind Platform UI section. You would have to add the highlight label to test with these repos (e.g. create the label and add it to some of the PRs associated with the highlights from the June 22 release).
Here's what I got during testing and where the content should perhaps be moved to (if something doesn't fit into the latter two sections it just defaults to the first section).
There was a problem hiding this comment.
When I tested your PR, I noticed that the script also generates a
highlight.qmdfile, alongside this parent release notes topic with the date in it. I would perhaps omit creating this extra file and putting the release highlights right into the file you're creating here.
PRs with the highlight label are now under '## Release highlights' in release highlights and 'highlight.qmd' no longer exists. I only addressed this part of the comment, since the additional repos are being dealt with in the followup story by Parris.
Co-authored-by: Nik Richers <nik@validmind.ai>
|
@p-m-s-f please test this PR locally as part of taking over from Sydney and approve if you think it's ready to be merged? |
|
@nrichers sorry it took me a while to get around to taking a look, the script works fine as intended. one thing i noticed, though, is that if you enter the release date without capitalizing the month, the title for the generated release notes will be in all lower case. i'm not sure if that's something @sydneysugar or i should fix before merging, or if we just have to be careful to always capitalize the month when entering the date.
|
Internal Notes for Reviewers
Created the generate_release_notes.py script and added action to makefile.
External Release Notes