What's new: Automate updating release notes #3797
Conversation
…erans-affairs/vets-design-system-documentation into db/fetch-release-notes
| @@ -7,7 +7,8 @@ | |||
| "test": "echo \"Error: no test specified\" && exit 1", | |||
| "build": "gulp build", | |||
| "start": "yarn run build && bundle exec jekyll serve --baseurl ''", | |||
| "watch": "yarn run build && bundle exec jekyll serve --baseurl '' --incremental" | |||
| "watch": "yarn run build && bundle exec jekyll serve --baseurl '' --incremental", | |||
| "update-releases": "rm -rf json_data_cache && yarn run build && bundle exec jekyll serve --baseurl ''" | |||
There was a problem hiding this comment.
Since the script removes the json_data_cache folder and rebuilds it each time there's an update, maybe add that folder to the .gitignore?
There was a problem hiding this comment.
Yeah, I went back and forth on this. I originally had it, but that means when everyone runs their local envs, it will fetch the JSON files. It also will fetch any time production is updated. Github does have a rate limit (not that I expect that we'd hit it), but think it's better to not have these requests until we're sure that's how we want it to operate. For now, I think we want to manually kick off this process when we deploy the package to vets-website. I think we should add this to the backlog to investigate further.
|
I'll wait until this sprint's component library release happens before merging so we get the updated changelog from it. |
Definitely! We broke out the documentation part so we can get this release quickly to prevent the timesink that is manual release notes. I have a local copy started for the README updates. I have a little more finagling to do on it, but would love to get your input. |
There was a problem hiding this comment.
This is awesome @danbrady! My only feedback is:
- Maybe update the repo README with some details on how to run and maintain this.
- The Figma embed is rad! As there are more releases created, would this keep getting pushed further and further down the page (making it harder to find)?
I just realized there's a sidebar on the right to jump down to that section! That seems like a nice solution: |
Both the complib and doc site are set to only display the last 3 release changelogs. (This is configurable per repo, if we want to change it.) So unless one specific release has a LOT of changes, items below shouldn't get pushed too far down. However, I'm not thrilled about stacking each channels release notes. The sticky sidebar was a way to help navigate around that, but it's a bit of a bandaid, IMO. What I think would better is probably using a tabs component to toggle figma/docs/code changelog you want to view. However, we'll have to dev a tabs component first. :) |
|
Just following up to mention I posted a PR with an updated README on how this all works if interested! Any and all feedback welcomed! |
First run
yarn startand view the What's New page. Note the release numbers in the tags within the cards.If there are new releases, stop your local server, and run
yarn run update-releases.While Jekyll is building, you should see "Caching [github json url]...":
After it completes, visit the What's New page and note the updated releases.