2018-02-04 11:18:09 +00:00
|
|
|
import { sort as semverSort, SemVer } from 'semver'
|
|
|
|
|
2018-02-04 02:32:55 +00:00
|
|
|
import { spawn } from '../changelog/spawn'
|
|
|
|
import { getLogLines } from '../changelog/git'
|
2018-02-04 04:16:32 +00:00
|
|
|
import {
|
|
|
|
convertToChangelogFormat,
|
|
|
|
getChangelogEntriesSince,
|
|
|
|
} from '../changelog/parser'
|
2018-02-04 11:18:09 +00:00
|
|
|
|
|
|
|
import { Channel } from './channel'
|
2018-02-04 00:32:38 +00:00
|
|
|
import { getNextVersionNumber } from './version'
|
2020-01-30 14:34:14 +00:00
|
|
|
import { execSync } from 'child_process'
|
|
|
|
|
|
|
|
import { writeFileSync } from 'fs'
|
2020-01-30 14:39:21 +00:00
|
|
|
import { join } from 'path'
|
2020-01-31 03:13:57 +00:00
|
|
|
import { format } from 'prettier'
|
2020-01-30 14:39:21 +00:00
|
|
|
|
|
|
|
const changelogPath = join(__dirname, '..', '..', 'changelog.json')
|
2018-02-03 23:35:23 +00:00
|
|
|
|
2020-02-04 22:33:46 +00:00
|
|
|
/**
|
|
|
|
* Returns the latest release tag, according to git and semver
|
|
|
|
* (ignores test releases)
|
|
|
|
*
|
|
|
|
* @param options there's only one option `excludeBetaReleases`,
|
|
|
|
* which is a boolean
|
|
|
|
*/
|
2018-02-09 04:04:30 +00:00
|
|
|
async function getLatestRelease(options: {
|
|
|
|
excludeBetaReleases: boolean
|
|
|
|
}): Promise<string> {
|
2018-02-03 23:35:23 +00:00
|
|
|
const allTags = await spawn('git', ['tag'])
|
|
|
|
let releaseTags = allTags
|
|
|
|
.split('\n')
|
|
|
|
.filter(tag => tag.startsWith('release-'))
|
2020-01-30 14:34:14 +00:00
|
|
|
.filter(tag => !tag.includes('-linux'))
|
|
|
|
.filter(tag => !tag.includes('-test'))
|
2018-02-03 23:35:23 +00:00
|
|
|
|
2018-02-09 04:04:30 +00:00
|
|
|
if (options.excludeBetaReleases) {
|
2020-01-30 14:34:14 +00:00
|
|
|
releaseTags = releaseTags.filter(tag => !tag.includes('-beta'))
|
2018-02-03 23:35:23 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
const releaseVersions = releaseTags.map(tag => tag.substr(8))
|
|
|
|
|
|
|
|
const sortedTags = semverSort(releaseVersions)
|
|
|
|
const latestTag = sortedTags[sortedTags.length - 1]
|
|
|
|
|
2018-02-09 03:55:45 +00:00
|
|
|
return latestTag instanceof SemVer ? latestTag.raw : latestTag
|
2018-02-03 23:35:23 +00:00
|
|
|
}
|
|
|
|
|
2020-02-04 22:33:46 +00:00
|
|
|
/** Converts a string to Channel type if possible */
|
2018-02-04 11:17:04 +00:00
|
|
|
function parseChannel(arg: string): Channel {
|
2018-02-09 04:04:30 +00:00
|
|
|
if (arg === 'production' || arg === 'beta' || arg === 'test') {
|
2018-02-04 01:15:29 +00:00
|
|
|
return arg
|
|
|
|
}
|
|
|
|
|
|
|
|
throw new Error(`An invalid channel ${arg} has been provided`)
|
|
|
|
}
|
|
|
|
|
2020-02-04 22:33:46 +00:00
|
|
|
/**
|
|
|
|
* Prints out next steps to the console
|
|
|
|
*
|
|
|
|
* @param nextVersion version for the next release
|
|
|
|
* @param entries release notes for the next release
|
|
|
|
*/
|
2018-02-04 04:16:32 +00:00
|
|
|
function printInstructions(nextVersion: string, entries: Array<string>) {
|
2020-01-31 03:13:57 +00:00
|
|
|
const baseSteps = [
|
2020-02-19 14:21:19 +00:00
|
|
|
'Revise the release notes according to https://github.com/desktop/desktop/blob/development/docs/process/writing-release-notes.md',
|
2020-02-19 14:30:43 +00:00
|
|
|
'Lint them with: yarn draft-release:format',
|
2020-02-19 14:21:19 +00:00
|
|
|
'Commit these changes (on a "release" branch) and push them to GitHub',
|
2019-01-09 18:02:04 +00:00
|
|
|
'Read this to perform the release: https://github.com/desktop/desktop/blob/development/docs/process/releasing-updates.md',
|
2018-02-09 04:47:47 +00:00
|
|
|
]
|
2020-02-19 14:30:50 +00:00
|
|
|
// if an empty list, we assume the new entries have already been
|
|
|
|
// written to the changelog file
|
2020-01-31 03:13:57 +00:00
|
|
|
if (entries.length === 0) {
|
|
|
|
printSteps(baseSteps)
|
|
|
|
} else {
|
2020-02-19 14:30:43 +00:00
|
|
|
const object: any = {}
|
|
|
|
object[nextVersion] = entries.sort()
|
|
|
|
const steps = [
|
2020-01-31 03:13:57 +00:00
|
|
|
`Concatenate this to the beginning of the 'releases' element in the changelog.json as a starting point:\n${format(
|
|
|
|
JSON.stringify(object),
|
2020-02-19 14:30:43 +00:00
|
|
|
{
|
|
|
|
parser: 'json',
|
|
|
|
}
|
2020-01-31 03:13:57 +00:00
|
|
|
)}\n`,
|
|
|
|
...baseSteps,
|
2020-02-19 14:30:43 +00:00
|
|
|
]
|
|
|
|
printSteps(steps)
|
2020-01-31 03:13:57 +00:00
|
|
|
}
|
|
|
|
}
|
2018-02-09 04:47:47 +00:00
|
|
|
|
2020-02-19 14:30:50 +00:00
|
|
|
/**
|
|
|
|
* adds a number to the beginning fo each line and prints them in sequence
|
|
|
|
*/
|
2020-01-31 03:13:57 +00:00
|
|
|
function printSteps(steps: ReadonlyArray<string>) {
|
2018-02-09 04:47:47 +00:00
|
|
|
console.log(steps.map((value, index) => `${index + 1}. ${value}`).join('\n'))
|
2018-02-04 03:51:21 +00:00
|
|
|
}
|
|
|
|
|
2018-02-03 23:35:23 +00:00
|
|
|
export async function run(args: ReadonlyArray<string>): Promise<void> {
|
|
|
|
if (args.length === 0) {
|
|
|
|
throw new Error(
|
|
|
|
`You have not specified a channel to draft this release for. Choose one of 'production' or 'beta'`
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
2018-02-04 01:15:29 +00:00
|
|
|
const channel = parseChannel(args[0])
|
2018-02-04 00:32:38 +00:00
|
|
|
const excludeBetaReleases = channel === 'production'
|
2018-02-09 04:04:30 +00:00
|
|
|
const previousVersion = await getLatestRelease({ excludeBetaReleases })
|
2018-02-04 02:32:55 +00:00
|
|
|
const nextVersion = getNextVersionNumber(previousVersion, channel)
|
|
|
|
|
2018-02-04 02:37:26 +00:00
|
|
|
const lines = await getLogLines(`release-${previousVersion}`)
|
2018-02-04 05:16:58 +00:00
|
|
|
const noChangesFound = lines.every(l => l.trim().length === 0)
|
|
|
|
|
|
|
|
if (noChangesFound) {
|
2020-02-19 14:41:35 +00:00
|
|
|
console.warn('No new changes found to add to the changelog. Aborting.')
|
2020-02-04 22:33:46 +00:00
|
|
|
// print instructions with no changelog included
|
2018-02-04 05:16:58 +00:00
|
|
|
printInstructions(nextVersion, [])
|
2020-01-31 03:13:57 +00:00
|
|
|
return
|
|
|
|
}
|
|
|
|
console.log(`Setting app version to "${nextVersion}" in app/package.json...`)
|
2020-02-08 00:36:00 +00:00
|
|
|
|
|
|
|
try {
|
|
|
|
// this can throw
|
2020-02-19 14:30:50 +00:00
|
|
|
// sets the npm version in app/
|
2020-02-08 00:36:00 +00:00
|
|
|
execSync(`npm version ${nextVersion} --allow-same-version`, {
|
|
|
|
cwd: join(__dirname, '..', '..', 'app'),
|
|
|
|
encoding: 'utf8',
|
|
|
|
})
|
|
|
|
console.log(`Set!`)
|
|
|
|
} catch (e) {
|
|
|
|
console.warn(`Setting the app version failed 😿
|
|
|
|
(${e.message})
|
|
|
|
Please manually set it to ${nextVersion} in app/package.json.`)
|
|
|
|
}
|
2020-01-31 03:13:57 +00:00
|
|
|
|
|
|
|
const currentChangelog = require(changelogPath)
|
2020-02-19 14:51:03 +00:00
|
|
|
// if it's a new production release, make sure we only include
|
|
|
|
// entries since the latest production release
|
|
|
|
const newEntries =
|
|
|
|
channel === 'production'
|
|
|
|
? [...getChangelogEntriesSince(previousVersion)]
|
|
|
|
: [...(await convertToChangelogFormat(lines))]
|
2020-01-31 03:13:57 +00:00
|
|
|
|
|
|
|
if (currentChangelog.releases[nextVersion] === undefined) {
|
|
|
|
console.log('Adding draft release notes to changelog.json...')
|
|
|
|
const changelog = makeNewChangelog(
|
|
|
|
nextVersion,
|
2020-02-19 14:41:35 +00:00
|
|
|
currentChangelog,
|
2020-01-31 03:13:57 +00:00
|
|
|
newEntries
|
|
|
|
)
|
2020-02-08 00:36:00 +00:00
|
|
|
try {
|
|
|
|
// this might throw
|
|
|
|
writeFileSync(
|
|
|
|
changelogPath,
|
|
|
|
format(JSON.stringify(changelog), {
|
|
|
|
parser: 'json',
|
|
|
|
})
|
|
|
|
)
|
|
|
|
printInstructions(nextVersion, [])
|
|
|
|
} catch (e) {
|
|
|
|
console.warn(`Writing the changelog failed 😿\n(${e.message})`)
|
|
|
|
printInstructions(nextVersion, newEntries)
|
|
|
|
}
|
2018-02-04 05:16:58 +00:00
|
|
|
} else {
|
2020-01-30 14:34:14 +00:00
|
|
|
console.log(
|
2020-01-31 03:13:57 +00:00
|
|
|
`Looks like there are already release notes for ${nextVersion} in changelog.json.`
|
2020-01-30 14:34:14 +00:00
|
|
|
)
|
|
|
|
|
2020-01-31 03:13:57 +00:00
|
|
|
printInstructions(nextVersion, newEntries)
|
|
|
|
}
|
2020-01-30 14:34:14 +00:00
|
|
|
|
2020-01-31 03:13:57 +00:00
|
|
|
console.log("Here's what you should do next:\n")
|
|
|
|
}
|
|
|
|
|
2020-02-19 14:30:50 +00:00
|
|
|
/**
|
|
|
|
* Returns the current changelog with new entries added.
|
|
|
|
* Ensures that the new entry will appear at the beginning
|
|
|
|
* of the object when printed.
|
|
|
|
*/
|
2020-01-31 03:13:57 +00:00
|
|
|
function makeNewChangelog(
|
|
|
|
nextVersion: string,
|
2020-02-19 14:41:35 +00:00
|
|
|
currentChangelog: { releases: Object },
|
2020-01-31 03:13:57 +00:00
|
|
|
entries: ReadonlyArray<string>
|
|
|
|
) {
|
2020-02-08 00:36:20 +00:00
|
|
|
const newChangelogEntries: any = {}
|
|
|
|
newChangelogEntries[nextVersion] = entries
|
2020-02-19 14:41:35 +00:00
|
|
|
return {
|
|
|
|
releases: { ...newChangelogEntries, ...currentChangelog.releases },
|
|
|
|
}
|
2018-02-03 23:35:23 +00:00
|
|
|
}
|