sanity icon indicating copy to clipboard operation
sanity copied to clipboard

build: add better release notes script

Open ricokahler opened this issue 3 years ago • 1 comments

Description

I've attempted this before, but I think I got it this time. This PR adds a more automated release notes scripts.

How it works:

  1. The PR template has much more clear instructions as well symbols it can use to parse info out of it
  2. The release script goes through each commit and grabs the associated PR
  3. It parses the bodies of all the PRs and returns a formatted release notes starter. This starter can then be edited by editorial like normal.

I also threw in a style guide for the release notes to make it more clear how to write these things (though it could use some improvement)

What to review

  • The script itself
  • The updated PR template
  • The new styled guide

Notes for release

N/A

ricokahler avatar Feb 09 '22 19:02 ricokahler

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

studio-workshop – ./dev/workshop

🔍 Inspect: https://vercel.com/sanity-io/studio-workshop/ENLVrMGWHv6dLmKCKo37fqqmd6DQ
✅ Preview: https://studio-workshop-git-build-better-release-notes.sanity.build

test-studio – ./

🔍 Inspect: https://vercel.com/sanity-io/test-studio/9H4qAKjURrUkckURwvwf73gUvw9o
✅ Preview: https://test-studio-git-build-better-release-notes.sanity.build

perf-studio – ./

🔍 Inspect: https://vercel.com/sanity-io/perf-studio/DpjmSGRtPfysLd9iNM9mAoJ34wx5
✅ Preview: https://perf-studio-git-build-better-release-notes.sanity.build

vercel[bot] avatar Feb 09 '22 19:02 vercel[bot]

Will revisit this in the future - ideally we want to create a draft changelog entry in Sanity + have a webhook trigger creation/updates against the GitHub releases API based on that source data, in order to have a single source of truth. Leaving the branch since we'll reuse a lot of the parsing logic here!

rexxars avatar Aug 11 '22 18:08 rexxars