Skip to content

Release: Fix not escaping content of GH Releases #23009

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.

Sign up for GitHub

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

Merged
kasperpeulen merged 1 commit into from
Jun 9, 2023
Merged

Release: Fix not escaping content of GH Releases #23009

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions scripts/release/get-changelog-from-file.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,14 @@ program
'get changelog entry for specific version. If not version argument specified it will use the current version in code/package.json'
)
.arguments('[version]')
.option('-E, --no-escape', 'Escape quote-like characters, so the output is safe in CLIs', true)
.option('-V, --verbose', 'Enable verbose logging', false);

export const getChangelogFromFile = async (args: { version?: string; verbose?: boolean }) => {
export const getChangelogFromFile = async (args: {
version?: string;
escape?: boolean;
verbose?: boolean;
}) => {
const version = args.version || (await getCurrentVersion());
const isPrerelease = semver.prerelease(version) !== null;
const changelogFilename = isPrerelease ? 'CHANGELOG.prerelease.md' : 'CHANGELOG.md';
Expand All @@ -33,10 +38,16 @@ export const getChangelogFromFile = async (args: { version?: string; verbose?: b
)}`
);
}
const result = `## ${changelogForVersion}`;
const result = args.escape
? `## ${changelogForVersion}`
.replaceAll('"', '\\"')
.replaceAll('`', '\\`')
.replaceAll("'", "\\'")
: `## ${changelogForVersion}`;

console.log(dedent`📝 Changelog entry found:
${result}`);

if (process.env.GITHUB_ACTIONS === 'true') {
setOutput('changelog', result);
}
Expand All @@ -45,7 +56,11 @@ export const getChangelogFromFile = async (args: { version?: string; verbose?: b

if (require.main === module) {
const parsed = program.parse();
getChangelogFromFile({ version: parsed.args[0], verbose: parsed.opts().verbose }).catch((err) => {
getChangelogFromFile({
version: parsed.args[0],
escape: parsed.opts().escape,
verbose: parsed.opts().verbose,
}).catch((err) => {
console.error(err);
process.exit(1);
});
Expand Down