forked from graphql/graphql-js
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
312 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
name: test | ||
|
||
on: | ||
push: | ||
branches: | ||
- test | ||
|
||
env: | ||
NODE_VERSION_USED_FOR_DEVELOPMENT: 18 | ||
jobs: | ||
test: | ||
name: Test | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout Repo | ||
uses: actions/checkout@v2 | ||
with: | ||
# This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits | ||
fetch-depth: 0 | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v2 | ||
with: | ||
node-version: ${{ env.NODE_VERSION_USED_FOR_DEVELOPMENT }} | ||
|
||
- name: Cache Node.js modules | ||
uses: actions/cache@v2 | ||
with: | ||
path: ~/.npm | ||
key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }} | ||
restore-keys: | | ||
${{ runner.OS }}-node- | ||
- name: Install Dependencies | ||
run: npm ci | ||
|
||
- name: Run Changelog | ||
run: | | ||
npm run changelog |
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,272 @@ | ||
import { git, readPackageJSON } from './utils.js'; | ||
|
||
const packageJSON = readPackageJSON(); | ||
const labelsConfig = { | ||
'PR: breaking change 💥': { | ||
section: 'Breaking Change 💥', | ||
}, | ||
'PR: deprecation ⚠': { | ||
section: 'Deprecation ⚠', | ||
}, | ||
'PR: feature 🚀': { | ||
section: 'New Feature 🚀', | ||
}, | ||
'PR: bug fix 🐞': { | ||
section: 'Bug Fix 🐞', | ||
}, | ||
'PR: docs 📝': { | ||
section: 'Docs 📝', | ||
fold: true, | ||
}, | ||
'PR: polish 💅': { | ||
section: 'Polish 💅', | ||
fold: true, | ||
}, | ||
'PR: internal 🏠': { | ||
section: 'Internal 🏠', | ||
fold: true, | ||
}, | ||
'PR: dependency 📦': { | ||
section: 'Dependency 📦', | ||
fold: true, | ||
}, | ||
}; | ||
const { GH_TOKEN } = process.env; | ||
|
||
if (GH_TOKEN == null) { | ||
console.error('Must provide GH_TOKEN as environment variable!'); | ||
process.exit(1); | ||
} | ||
|
||
if (!packageJSON.repository || typeof packageJSON.repository.url !== 'string') { | ||
console.error('package.json is missing repository.url string!'); | ||
process.exit(1); | ||
} | ||
|
||
const repoURLMatch = | ||
/https:\/\/github.com\/(?<githubOrg>[^/]+)\/(?<githubRepo>[^/]+).git/.exec( | ||
packageJSON.repository.url, | ||
); | ||
if (repoURLMatch?.groups == null) { | ||
console.error('Cannot extract organization and repo name from repo URL!'); | ||
process.exit(1); | ||
} | ||
const { githubOrg, githubRepo } = repoURLMatch.groups; | ||
|
||
process.stdout.write(await genChangeLog()); | ||
|
||
async function genChangeLog() { | ||
const { version } = packageJSON; | ||
|
||
let tag = null; | ||
let commitsList = git().revList('--reverse', `v${version}..`); | ||
if (commitsList.length === 0) { | ||
const parentPackageJSON = git().catFile('blob', 'HEAD~1:package.json'); | ||
const parentVersion = JSON.parse(parentPackageJSON).version; | ||
commitsList = git().revList('--reverse', `v${parentVersion}..HEAD~1`); | ||
tag = `v${version}`; | ||
} | ||
|
||
const allPRs = await getPRsInfo(commitsList); | ||
const date = git().log('-1', '--format=%cd', '--date=short'); | ||
|
||
const byLabel = {}; | ||
const committersByLogin = {}; | ||
|
||
for (const pr of allPRs) { | ||
const labels = pr.labels.nodes | ||
.map((label) => label.name) | ||
.filter((label) => label.startsWith('PR: ')); | ||
|
||
if (labels.length === 0) { | ||
throw new Error(`PR is missing label. See ${pr.url}`); | ||
} | ||
if (labels.length > 1) { | ||
throw new Error( | ||
`PR has conflicting labels: ${labels.join('\n')}\nSee ${pr.url}`, | ||
); | ||
} | ||
|
||
const label = labels[0]; | ||
if (labelsConfig[label] == null) { | ||
throw new Error(`Unknown label: ${label}. See ${pr.url}`); | ||
} | ||
byLabel[label] ??= []; | ||
byLabel[label].push(pr); | ||
committersByLogin[pr.author.login] = pr.author; | ||
} | ||
|
||
let changelog = `## ${tag ?? 'Unreleased'} (${date})\n`; | ||
for (const [label, config] of Object.entries(labelsConfig)) { | ||
const prs = byLabel[label]; | ||
if (prs != null) { | ||
const shouldFold = config.fold && prs.length > 1; | ||
|
||
changelog += `\n#### ${config.section}\n`; | ||
if (shouldFold) { | ||
changelog += '<details>\n'; | ||
changelog += `<summary> ${prs.length} PRs were merged </summary>\n\n`; | ||
} | ||
|
||
for (const pr of prs) { | ||
const { number, url, author } = pr; | ||
changelog += `* [#${number}](${url}) ${pr.title} ([@${author.login}](${author.url}))\n`; | ||
} | ||
|
||
if (shouldFold) { | ||
changelog += '</details>\n'; | ||
} | ||
} | ||
} | ||
|
||
const committers = Object.values(committersByLogin).sort((a, b) => | ||
(a.name || a.login).localeCompare(b.name || b.login), | ||
); | ||
changelog += `\n#### Committers: ${committers.length}\n`; | ||
for (const committer of committers) { | ||
changelog += `* ${committer.name}([@${committer.login}](${committer.url}))\n`; | ||
} | ||
|
||
return changelog; | ||
} | ||
|
||
async function graphqlRequest(query) { | ||
const response = await fetch('https://github.com/gitapi/graphql', { | ||
method: 'POST', | ||
headers: { | ||
Authorization: 'bearer ' + GH_TOKEN, | ||
'Content-Type': 'application/json', | ||
'User-Agent': 'gen-changelog', | ||
}, | ||
body: JSON.stringify({ query }), | ||
}); | ||
|
||
if (!response.ok) { | ||
throw new Error( | ||
`GitHub responded with ${response.status}: ${response.statusText}\n` + | ||
(await response.text()), | ||
); | ||
} | ||
|
||
const json = await response.json(); | ||
if (json.errors != null) { | ||
throw new Error('Errors: ' + JSON.stringify(json.errors, null, 2)); | ||
} | ||
return json.data; | ||
} | ||
|
||
async function batchCommitToPR(commits) { | ||
let commitsSubQuery = ''; | ||
for (const oid of commits) { | ||
commitsSubQuery += ` | ||
commit_${oid}: object(oid: "${oid}") { | ||
... on Commit { | ||
oid | ||
message | ||
associatedPullRequests(first: 10) { | ||
nodes { | ||
number | ||
repository { | ||
nameWithOwner | ||
} | ||
} | ||
} | ||
} | ||
} | ||
`; | ||
} | ||
|
||
const response = await graphqlRequest(` | ||
{ | ||
repository(owner: "${githubOrg}", name: "${githubRepo}") { | ||
${commitsSubQuery} | ||
} | ||
} | ||
`); | ||
|
||
const prNumbers = []; | ||
for (const oid of commits) { | ||
const commitInfo = response.repository['commit_' + oid]; | ||
prNumbers.push(commitInfoToPR(commitInfo)); | ||
} | ||
return prNumbers; | ||
} | ||
|
||
async function batchPRInfo(prNumbers) { | ||
let prsSubQuery = ''; | ||
for (const number of prNumbers) { | ||
prsSubQuery += ` | ||
pr_${number}: pullRequest(number: ${number}) { | ||
number | ||
title | ||
url | ||
author { | ||
login | ||
url | ||
... on User { | ||
name | ||
} | ||
} | ||
labels(first: 10) { | ||
nodes { | ||
name | ||
} | ||
} | ||
} | ||
`; | ||
} | ||
|
||
const response = await graphqlRequest(` | ||
{ | ||
repository(owner: "${githubOrg}", name: "${githubRepo}") { | ||
${prsSubQuery} | ||
} | ||
} | ||
`); | ||
|
||
const prsInfo = []; | ||
for (const number of prNumbers) { | ||
prsInfo.push(response.repository['pr_' + number]); | ||
} | ||
return prsInfo; | ||
} | ||
|
||
function commitInfoToPR(commit) { | ||
const associatedPRs = commit.associatedPullRequests.nodes.filter( | ||
(pr) => pr.repository.nameWithOwner === `${githubOrg}/${githubRepo}`, | ||
); | ||
if (associatedPRs.length === 0) { | ||
const match = / \(#(?<prNumber>[0-9]+)\)$/m.exec(commit.message); | ||
if (match?.groups?.prNumber != null) { | ||
return parseInt(match.groups.prNumber, 10); | ||
} | ||
throw new Error( | ||
`Commit ${commit.oid} has no associated PR: ${commit.message}`, | ||
); | ||
} | ||
if (associatedPRs.length > 1) { | ||
throw new Error( | ||
`Commit ${commit.oid} is associated with multiple PRs: ${commit.message}`, | ||
); | ||
} | ||
|
||
return associatedPRs[0].number; | ||
} | ||
|
||
async function getPRsInfo(commits) { | ||
let prNumbers = await splitBatches(commits, batchCommitToPR); | ||
prNumbers = Array.from(new Set(prNumbers)); // Remove duplicates | ||
|
||
return splitBatches(prNumbers, batchPRInfo); | ||
} | ||
|
||
// Split commits into batches of 50 to prevent timeouts | ||
async function splitBatches(array, batchFn) { | ||
const promises = []; | ||
for (let i = 0; i < array.length; i += 50) { | ||
const batchItems = array.slice(i, i + 50); | ||
promises.push(batchFn(batchItems)); | ||
} | ||
|
||
return (await Promise.all(promises)).flat(); | ||
} |