mirror of
https://github.com/directus/directus.git
synced 2026-04-25 03:00:53 -04:00
05d901a3dd
* Support adding additional info to release notes via changesets * Update test * Simplify regex since summary is already trimmed by changesets * Simplify again, split up into new util & add test * Add comment to regex * Enhancements - Better terms: Use "notice" instead of "info" - Support placing notice everywhere in the summary - Enhance format of notices in release notes * Print notices under 'Potential Breaking Changes' * Update tests * Update format * Fix new lines & improve tests --------- Co-authored-by: Rijk van Zanten <rijkvanzanten@me.com>
@directus/release-notes-generator
A release notes generator for changesets used by Directus
Installation
npm install @directus/release-notes-generator
Usage
Update the .changeset/config.json file to point to this package:
"changelog": "@directus/release-notes-generator",
The release notes will be generated and printed when running the changesets command to update the versions:
GITHUB_TOKEN=<token> pnpm changeset version
For local use, you'll need a GitHub personal access token with read:user and repo:status permissions.
GitHub CI
When running pnpm changeset version in the GitHub CI context, this package will automatically set the following outputs:
DIRECTUS_MAIN_VERSIONDIRECTUS_RELEASE_NOTES