-
Notifications
You must be signed in to change notification settings - Fork 826
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add script to update changelogs on release preparation (#4315)
* feat: add script to update changelogs on releases * fix: address comments * Apply suggestions from code review Co-authored-by: Trent Mick <trentm@gmail.com> * fix: apply suggestions from code review * fix: use packageJson.version instead of version --------- Co-authored-by: Trent Mick <trentm@gmail.com>
- Loading branch information
1 parent
38db748
commit f654636
Showing
4 changed files
with
75 additions
and
28 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| /** | ||
| * This script updates changelogs after lerna has updated versions in the respective areas (packages/*, experimental/packages/*) | ||
| * - removes all empty subsections (bugs, enhancements, etc.) in the changelog. | ||
| * - replaces the "Unreleased"-header with the version from the first non-private package in the directory (versions are expected to be uniform across a changelog) | ||
| * - adds a new "Unreleased"-header with empty subsections at the top | ||
| * | ||
| * Usage (from project root): | ||
| * - node scripts/update-changelog.js [PATH TO CHANGELOG] [DIRECTORY CONTAINING ASSOCIATED PACKAGES] | ||
| * Examples: | ||
| * - node scripts/update-changelog.js ./CHANGELOG.md ./packages | ||
| * - node scripts/update-changelog.js ./experimental/CHANGELOG.md ./experimental/packages | ||
| */ | ||
|
|
||
| const fs = require('fs'); | ||
| const path = require("path"); | ||
|
|
||
| const EMPTY_UNRELEASED_SECTION = `## Unreleased | ||
| ### :boom: Breaking Change | ||
| ### :rocket: (Enhancement) | ||
| ### :bug: (Bug Fix) | ||
| ### :books: (Refine Doc) | ||
| ### :house: (Internal) | ||
| ` | ||
|
|
||
| function findFirstPackageVersion(basePath){ | ||
| const packageDirs = fs.readdirSync(basePath); | ||
| for(const packageDir of packageDirs){ | ||
| const packageJsonPath = path.join(basePath, packageDir, 'package.json'); | ||
| try { | ||
| const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8')); | ||
|
|
||
| if(packageJson.private === true || packageJson.private === 'true'){ | ||
| console.log('Skipping version from private package at', packageJsonPath); | ||
| continue; | ||
| } | ||
|
|
||
| if(packageJson.version != null){ | ||
| return packageJson.version; | ||
| } | ||
|
|
||
| console.log('Version in', packageJsonPath, 'was null or undefined, skipping'); | ||
| } catch (err) { | ||
| console.log('Could not get package JSON', packageJsonPath, err); | ||
| } | ||
| } | ||
| throw new Error('Unable to extract version from packages in ' + basePath); | ||
| } | ||
|
|
||
| // no special handling for bad args as this is only intended for use via predefined npm scripts. | ||
| const changelogPath = path.resolve(process.argv[2]); | ||
| const version = findFirstPackageVersion(path.resolve(process.argv[3])); | ||
|
|
||
| const changelog = fs.readFileSync(changelogPath, 'utf8').toString() | ||
| // replace all empty sections | ||
| .replace(new RegExp('^###.*\n*(?=^##)', 'gm'), '') | ||
| // replace unreleased header with new unreleased section and a version header for the former unreleased section | ||
| .replace(RegExp('## Unreleased'), EMPTY_UNRELEASED_SECTION + '## ' + version); | ||
|
|
||
| fs.writeFileSync(changelogPath, changelog); |