forked from desktop/desktop
-
Notifications
You must be signed in to change notification settings - Fork 511
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(tooling): introduce separate publish step which runs after build (…
- Loading branch information
Showing
5 changed files
with
301 additions
and
15 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,3 +17,4 @@ vendor/windows-argv-parser/build/ | |
| junit*.xml | ||
| *.swp | ||
| tslint-rules/ | ||
| script/release_notes.txt | ||
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,230 @@ | ||
| /* eslint-disable no-sync */ | ||
|
|
||
| const glob = require('glob') | ||
| const { dirname, join } = require('path') | ||
| const fs = require('fs') | ||
|
|
||
| type ReleaseNotesGroupType = 'new' | 'added' | 'fixed' | 'improved' | 'removed' | ||
|
|
||
| type ReleaseNotesGroups = Record<ReleaseNotesGroupType, Array<ReleaseNoteEntry>> | ||
|
|
||
| type ReleaseNoteEntry = { | ||
| text: string | ||
| ids: Array<number> | ||
| contributor?: string | ||
| } | ||
|
|
||
| // 3 architectures * 3 package formats * 2 files (package + checksum file) | ||
| const SUCCESSFUL_RELEASE_FILE_COUNT = 3 * 3 * 2 | ||
|
|
||
| const Glob = glob.GlobSync | ||
|
|
||
| const args = process.argv.slice(2) | ||
| const artifactsDir = args[0] | ||
|
|
||
| if (!artifactsDir) { | ||
| console.error( | ||
| `🔴 First parameter with artifacts directory not found. Aborting...` | ||
| ) | ||
| process.exit(1) | ||
| } | ||
|
|
||
| const releaseTagWithoutPrefix = args[1] | ||
| if (!releaseTagWithoutPrefix) { | ||
| console.error(`🔴 Second parameter with release tag not found. Aborting...`) | ||
| process.exit(1) | ||
| } | ||
|
|
||
| console.log( | ||
| `Preparing release notes for release tag ${releaseTagWithoutPrefix}` | ||
| ) | ||
|
|
||
| const files = new Glob(artifactsDir + '/**/*', { nodir: true }) | ||
|
|
||
| const matches = files.found as Array<string> | ||
|
|
||
| const fileCount = matches.length | ||
|
|
||
| if (SUCCESSFUL_RELEASE_FILE_COUNT !== fileCount) { | ||
| console.error( | ||
| `🔴 Artifacts folder has ${fileCount} assets, expecting ${SUCCESSFUL_RELEASE_FILE_COUNT}. Please check the GH Actions artifacts to see which are missing.` | ||
| ) | ||
| process.exit(1) | ||
| } | ||
|
|
||
| console.log(`Found ${fileCount} files in artifacts directory`) | ||
|
|
||
| const releaseNotesByGroup = getReleaseGroups(releaseTagWithoutPrefix) | ||
|
|
||
| const draftReleaseNotes = generateDraftReleaseNotes(releaseNotesByGroup) | ||
| const releaseNotesPath = join(__dirname, 'release_notes.txt') | ||
|
|
||
| fs.writeFileSync(releaseNotesPath, draftReleaseNotes, { encoding: 'utf8' }) | ||
|
|
||
| console.log( | ||
| `✅ All done! The release notes have been written to ${releaseNotesPath}` | ||
| ) | ||
|
|
||
| function extractIds(str: string): Array<number> { | ||
| const idRegex = /#(\d+)/g | ||
|
|
||
| const idArray = new Array<number>() | ||
| let match | ||
|
|
||
| while ((match = idRegex.exec(str))) { | ||
| const textValue = match[1].trim() | ||
| const numValue = parseInt(textValue, 10) | ||
| if (!isNaN(numValue)) { | ||
| idArray.push(numValue) | ||
| } | ||
| } | ||
|
|
||
| return idArray | ||
| } | ||
|
|
||
| function parseCategory(str: string): ReleaseNotesGroupType | null { | ||
| const input = str.toLocaleLowerCase() | ||
| switch (input) { | ||
| case 'added': | ||
| case 'fixed': | ||
| case 'improved': | ||
| case 'new': | ||
| case 'removed': | ||
| return input | ||
| default: | ||
| return null | ||
| } | ||
| } | ||
|
|
||
| function isInitialTag(tag: string): boolean { | ||
| return tag.endsWith('-linux1') || tag.endsWith('-test1') | ||
| } | ||
|
|
||
| function getVersionWithoutSuffix(tag: string): string { | ||
| return tag.replace('-linux1', '').replace('-test1', '') | ||
| } | ||
|
|
||
| function getReleaseGroups(version: string): ReleaseNotesGroups { | ||
| if (!isInitialTag(version)) { | ||
| return { | ||
| new: [], | ||
| added: [], | ||
| fixed: [], | ||
| improved: [], | ||
| removed: [], | ||
| } | ||
| } | ||
|
|
||
| const upstreamVersion = getVersionWithoutSuffix(version) | ||
| const rootDir = dirname(__dirname) | ||
| const changelogFile = fs.readFileSync(join(rootDir, 'changelog.json')) | ||
| const changelogJson = JSON.parse(changelogFile) | ||
| const releases = changelogJson['releases'] | ||
| const changelogForVersion: Array<string> | undefined = | ||
| releases[upstreamVersion] | ||
|
|
||
| if (!changelogForVersion) { | ||
| console.error( | ||
| `🔴 Changelog version ${upstreamVersion} not found in changelog.json, which is required for publishing a release based off an upstream releease. Aborting...` | ||
| ) | ||
| process.exit(1) | ||
| } | ||
|
|
||
| console.log(`found release notes`, changelogForVersion) | ||
|
|
||
| const releaseNotesByGroup: ReleaseNotesGroups = { | ||
| new: [], | ||
| added: [], | ||
| fixed: [], | ||
| improved: [], | ||
| removed: [], | ||
| } | ||
|
|
||
| const releaseEntryExternalContributor = /\[(.*)\](.*)- (.*)\. Thanks (.*)!/ | ||
| const releaseEntryRegex = /\[(.*)\](.*)- (.*)/ | ||
|
|
||
| for (const entry of changelogForVersion) { | ||
| const externalMatch = releaseEntryExternalContributor.exec(entry) | ||
| if (externalMatch) { | ||
| const category = parseCategory(externalMatch[1]) | ||
| const text = externalMatch[2].trim() | ||
| const ids = extractIds(externalMatch[3]) | ||
| const contributor = externalMatch[4] | ||
|
|
||
| if (!category) { | ||
| console.warn(`unable to identify category for '${entry}'`) | ||
| } else { | ||
| releaseNotesByGroup[category].push({ | ||
| text, | ||
| ids, | ||
| contributor, | ||
| }) | ||
| } | ||
| } else { | ||
| const match = releaseEntryRegex.exec(entry) | ||
| if (match) { | ||
| const category = parseCategory(match[1]) | ||
| const text = match[2].trim() | ||
| const ids = extractIds(match[3]) | ||
| if (!category) { | ||
| console.warn(`unable to identify category for '${entry}'`) | ||
| } else { | ||
| releaseNotesByGroup[category].push({ | ||
| text, | ||
| ids, | ||
| }) | ||
| } | ||
| } else { | ||
| console.warn(`release entry does not match any format: '${entry}'`) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return releaseNotesByGroup | ||
| } | ||
|
|
||
| function formatReleaseNote(note: ReleaseNoteEntry): string { | ||
| const idsAsUrls = note.ids | ||
| .map(id => `https://github.com/desktop/desktop/issues/${id}`) | ||
| .join(' ') | ||
| const contributorNote = note.contributor | ||
| ? `. Thanks ${note.contributor}!` | ||
| : '' | ||
|
|
||
| const template = ` - ${note.text} - ${idsAsUrls}${contributorNote}` | ||
|
|
||
| return template.trim() | ||
| } | ||
|
|
||
| function renderSection( | ||
| name: string, | ||
| items: Array<ReleaseNoteEntry>, | ||
| omitIfEmpty: boolean = true | ||
| ): string { | ||
| if (items.length === 0 && omitIfEmpty) { | ||
| return '' | ||
| } | ||
|
|
||
| const itemsText = | ||
| items.length === 0 ? 'TODO' : items.map(formatReleaseNote).join('\n') | ||
|
|
||
| return ` | ||
| ## ${name} | ||
| ${itemsText} | ||
| ` | ||
| } | ||
|
|
||
| /** | ||
| * Takes the release notes entries and the SHA entries, then merges them into the full draft release notes ✨ | ||
| */ | ||
| function generateDraftReleaseNotes( | ||
| releaseNotesGroups: ReleaseNotesGroups | ||
| ): string { | ||
| return ` | ||
| ${renderSection('New', releaseNotesGroups.new)} | ||
| ${renderSection('Added', releaseNotesGroups.added)} | ||
| ${renderSection('Fixed', releaseNotesGroups.fixed, false)} | ||
| ${renderSection('Improved', releaseNotesGroups.improved, false)} | ||
| ${renderSection('Removed', releaseNotesGroups.removed)}` | ||
| } |
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