m/metamask-extension
1
0
Fork 0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
Code

Add --help flag to changelog script (#10846)

Browse Source 
The changelog script now accepts a `--help` flag, which prints a help
text explaining how the script works and what each flag does.
This commit is contained in:
Mark Stacey 2021-04-07 21:51:44 -02:30 committed by GitHub
parent 482cbfe929
commit b65a94b7f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
development/auto-changelog.js
View File

@ -8,6 +8,22 @@ const runCommand = require('./lib/runCommand');
const URL = 'https://github.com/MetaMask/metamask-extension';
const command = 'yarn update-changelog';
const helpText = `Usage: ${command} [--rc] [-h|--help]
Update CHANGELOG.md with any changes made since the most recent release.
Options:
--rc Add new changes to the current release header, rather than to the
'Unreleased' section.
-h, --help Display this help and exit.
New commits will be added to the "Unreleased" section (or to the section for the
current release if the '--rc' flag is used) in reverse chronological order. Any
commits for PRs that are represented already in the changelog will be ignored.
If the '--rc' flag is used and the section for the current release does not yet
exist, it will be created.
`;
async function main() {
const args = process.argv.slice(2);
let isReleaseCandidate = false;
@ -15,8 +31,14 @@ async function main() {
for (const arg of args) {
if (arg === '--rc') {
isReleaseCandidate = true;
} else if (['--help', '-h'].includes(arg)) {
console.log(helpText);
process.exit(0);
} else {
throw new Error(`Unrecognized argument: ${arg}`);
console.error(
`Unrecognized argument: ${arg}\nTry '${command} --help' for more information.\n`,
);
process.exit(1);
}
}