Skip to content

Include validmind-python and frontend in release notes #121

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

Merged
merged 20 commits into from
Jul 27, 2023

Conversation

sydneysugar
Copy link
Contributor

@sydneysugar sydneysugar commented Jul 21, 2023

Internal Notes for Reviewers

Responding to this story: https://app.shortcut.com/validmind/story/1781/roll-out-release-notes-process-to-other-repos

Updated release notes script to include validmind-python and frontend repos in the generated release notes.

Changes include:

  • Moved release_highlights_template.qmd to templates folder
  • No longer includes PRs if they have the 'internal' label
  • Uses GitHub releases to get the list of PRs. E.g., this one in validmind-python
  • Deals with duplicate PRs in the releases
  • Adds '..' characters to the release_highlights_template.qmd file for the script to search and replace with actual content

External Release Notes

@sydneysugar sydneysugar added the internal Not to be externalized in the release notes label Jul 21, 2023
@sydneysugar sydneysugar requested a review from nrichers July 21, 2023 22:49
sydneysugar and others added 4 commits July 24, 2023 11:04
* docs page for adding content block

* edited step 3 & added to left navbar

* Expand topic with more info, add animated GIF

* Remove markdowntest file

* Remove comment from source

* Add steps for test-driven content blocks, interim GIF update

* Text edit

* Text edit

---------

Co-authored-by: Nik Richers <nik@validmind.ai>
@nrichers nrichers mentioned this pull request Jul 25, 2023
@nrichers
Copy link
Collaborator

@sydneysugar to complete roll-out for this functionality, we still need to:

  • Add the CI checks to the validmind-python and frontend repos
  • Add the PR template to the same repos.

I chatted with Andres a bit about the script, but we probably want to set up that meeting with him (or you can just meet with him 1:1) to make sure any concerns are addressed before we start rolling out to these repos.

Did you want to work on these items while I review your script?

nrichers and others added 4 commits July 25, 2023 10:15
* WIP release notes draft

* Fix moved Python script

* Update notebook source from Google Drive

* WIP release notes draft

* WIP release notes updates, fix client integration docs

* WIP release notes draft

* WIP swap templates draft, WIP Makefile and source update

* Update rendered site

* Update Makefile for better notebooks handling

* Move release highlights template to avoid externalizing and to fix broken links

* Makefile tweak

* Fix June release notes link

* Update notebook source & render site

* Improve Makefile output

* Makefile tweak

* Release notes draft complete

* Update Jupyter notebooks page, add download option

* Add notebook downloads to release notes

* Add swap template docs

* Add swap template docs to Quarto YAML

* Fix formatting

* Remove stray line

* Rename Jupyter notebooks section to Samples

* Update license agreement

* Update rendered site

* Address review comments

* Update add content block animation
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

Wonderful updates to our release notes script, @sydneysugar! I left a few comments for you to address after testing, but this is looking really, really good. 🚀

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

T-h-i-s close, @sydneysugar! After retesting, I have only a couple of minor formatting comments before this PR can be approved:

For bullet points, can we put the description on the same line, separated by a period, instead of breaking it out onto a new paragraph?

For example,

<!---Create troubleshooting page by @sydneysugar in [#116](https://github.com/validmind/documentation/pull/116) --->
- **Create troubleshooting page**

New troubleshooting guide for addressing technical issues with the Developer Framework.

should look like

<!---Create troubleshooting page by @sydneysugar in [#116](https://github.com/validmind/documentation/pull/116) --->
- **Create troubleshooting page**. New troubleshooting guide for addressing technical issues with the Developer Framework.

Without this change, the formatting looks off in the output, e.g.

image

Also, the heading repetition (one with a date) should be simplified. It would likely make sense to just remove the H2 so you're just left with one H1. It's nice to have the dat, though, as search might return a whole bunch of "Documentation updates" otherwise.

This is some great work from you all around. Looking forward to using this for our next release!

@nrichers nrichers force-pushed the python-and-frontend-release-notes branch from 99a65fd to f572c18 Compare July 27, 2023 05:01
@nrichers
Copy link
Collaborator

nrichers commented Jul 27, 2023

@sydneysugar I accidentally pushed some local test changes to your PR, with an apology! I reset your branch to your last good commit and force pushed to remove my change, so your branch should now be in the same state as you left it. (Something something about muscle memory and me often committing and pushing in one go ...)

You might need to pull down your remote branch before pushing additional commits or simply force push your own changes with -f. That should resolve any errors due to git histories not matching.

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

Fantastic work, @sydneysugar! This is a great script. Good to merge once the version is shown for the Platform UI. We should likely also do another process demo or go over the how-to for the folks contributing to the validmind-python and frontend repos.

@sydneysugar sydneysugar merged commit 421770e into main Jul 27, 2023
@sydneysugar sydneysugar deleted the python-and-frontend-release-notes branch July 27, 2023 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants