Add changelog and prototype scripts+workflows for autogenerated entries and Slack digest - #637
Open
hey-august wants to merge 28 commits into
Open
Add changelog and prototype scripts+workflows for autogenerated entries and Slack digest#637hey-august wants to merge 28 commits into
hey-august wants to merge 28 commits into
Conversation
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Summary
This PR's goals:
User-facing: Enable Fern's Changelog feature. Populate it with a few weeks' worth of entries.
Not user-facing: Inert scripts and workflows (not yet wired into CI) for auto-generating changelog entries based on merged docs PRs. These are intended to run weekly. For current testing purposes, they can be invoked manually.
Pipeline
When invoked, this pipeline does the following:
signalwire/docsnotable,minor, orskipagainst a rubricnotableitems publish to the Changelog on the docsnotable+minorentries get sent as a digest to configurable internal SignalWire Slack channelsDuring the testing phase, the pipeline should be run manually each week.
During the test phase, the LLM step that classifies changes against the rubric is currently manual, and requires the reviewing DevEx human to run a generated prompt through Claude. Once we have a Gemini key, we can uncomment the relevant portion of
changelog-draft.yml.Open questions
Type of Change
Related Issues
Closes #636
(and goes well beyond it)
Testing
Tested with
yarn test:scripts(74),yarn fern-check,yarn fern-md-check. No workflow has run against the real repo yet.Checklist