Skip to content
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

chore: add script for generating an initial draft of release notes #162

Merged
merged 3 commits into from
Aug 10, 2024

Conversation

aleclarson
Copy link
Member

@aleclarson aleclarson commented Aug 9, 2024

Summary

Generate release notes using git log -p output and Anthropic Claude. Before the release notes are saved to file or published to GitHub, you'll have a chance to edit them with whatever editor you have set via git config --global core.editor <editor>.

Required Environment Variables

  • ANTHROPIC_API_KEY
  • GITHUB_TOKEN (only required if --publish is used)

Usage

# Generate release notes for changes between the last two
# stable versions.
scripts/release-notes.sh

# Generate release notes for changes between the last stable
# version and a given commit ref (e.g. HEAD).
scripts/release-notes.sh <commit-ref>

Options

-o, --output <file>
  Write the release notes to a file.

--publish
  Publish the release notes to GitHub.

--draft
  Publish the release notes as a draft.

--prerelease
  Publish the release notes as a prerelease.

Bundle impact

Status File Size

@aleclarson aleclarson merged commit d98ae18 into main Aug 10, 2024
5 checks passed
@aleclarson aleclarson deleted the chore/release-notes-script branch August 10, 2024 17:52
Copy link

A new beta version 12.2.0-beta.1ee40e2 has been published to NPM. 🚀

To install:

The radashi@beta tag also includes this PR.

See the changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant