feat: add option to generate explicit URLs in the release notes (#16126)

This commit is contained in:
Charles Kerr 2018-12-19 09:48:01 -06:00 committed by Shelley Vohr
parent ddc38eda26
commit df0381e76c
2 changed files with 33 additions and 23 deletions

View file

@ -120,7 +120,7 @@ const getPreviousPoint = async (point) => {
}
}
async function getReleaseNotes (range) {
async function getReleaseNotes (range, explicitLinks) {
const rangeList = range.split('..') || ['HEAD']
const to = rangeList.pop()
const from = rangeList.pop() || (await getPreviousPoint(to))
@ -128,7 +128,7 @@ async function getReleaseNotes (range) {
const notes = await notesGenerator.get(from, to)
const ret = {
text: notesGenerator.render(notes)
text: notesGenerator.render(notes, explicitLinks)
}
if (notes.unknown.length) {
@ -139,13 +139,15 @@ async function getReleaseNotes (range) {
}
async function main () {
if (process.argv.length > 3) {
console.log('Use: script/release-notes/index.js [tag | tag1..tag2]')
// TODO: minimist/commander
const explicitLinks = process.argv.slice(2).some(arg => arg === '--explicit-links')
if (process.argv.length > 4) {
console.log('Use: script/release-notes/index.js [--explicit-links] [tag | tag1..tag2]')
return 1
}
const range = process.argv[2] || 'HEAD'
const notes = await getReleaseNotes(range)
const notes = await getReleaseNotes(range, explicitLinks)
console.log(notes.text)
if (notes.warning) {
throw new Error(notes.warning)