Something went wrong. Try again.
Something went wrong. Try again.
11 kB · 354 lines
JavaScript
at master
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355const { classify } = require('../supportedBranches.js')
function runChecklist({ committers, events, files, pull_request, log, maintainers, user, userIsMaintainer,}) { const allByName = files.every( ({ filename }) => filename.startsWith('pkgs/by-name/') && filename.split('/').length > 4, )
const packages = files .filter(({ filename }) => filename.startsWith('pkgs/by-name/')) .map(({ filename }) => filename.split('/')[3]) .filter(Boolean)
const eligible = !packages.length ? new Set() : packages .map((pkg) => new Set(maintainers[pkg])) .reduce((acc, cur) => acc?.intersection(cur) ?? cur)
const approvals = new Set( events .filter( ({ event, state, commit_id }) => event === 'reviewed' && state === 'approved' && // Only approvals for the current head SHA count, otherwise authors could push // bad code between the approval and the merge. commit_id === pull_request.head.sha, ) .map(({ user }) => user?.id) // Some users have been deleted, so filter these out. .filter(Boolean), )
const checklist = { 'PR targets a [development branch](https://github.com/NixOS/nixpkgs/blob/-/ci/README.md#branch-classification).': classify(pull_request.base.ref).type.includes('development'), 'PR touches only files of packages in `pkgs/by-name/`.': allByName, 'PR is at least one of:': { 'Approved by a [committer](https://github.com/orgs/NixOS/teams/nixpkgs-committers).': committers.intersection(approvals).size > 0, 'Backported via label.': pull_request.user.login === 'nixpkgs-ci[bot]' && pull_request.head.ref.startsWith('backport-'), 'Opened by a [committer](https://github.com/orgs/NixOS/teams/nixpkgs-committers).': committers.has(pull_request.user.id), 'Opened by [@r-ryantm](https://nix-community.github.io/nixpkgs-update/r-ryantm/).': pull_request.user.login === 'r-ryantm', }, 'PR is not a draft': !pull_request.draft, }
if (user) { checklist[ `${user.login} is a member of [@NixOS/nixpkgs-maintainers](https://github.com/orgs/NixOS/teams/nixpkgs-maintainers).` ] = userIsMaintainer if (allByName) { // We can only determine the below, if all packages are in by-name, since // we can't reliably relate changed files to packages outside by-name. checklist[ `${user.login} is a maintainer of all touched packages on the ${pull_request.base.ref} branch.` ] = eligible.has(user.id) } } else { // This is only used when no user is passed, i.e. for labeling. checklist['PR has maintainers eligible to merge.'] = eligible.size > 0 }
const result = Object.values(checklist).every((v) => typeof v === 'boolean' ? v : Object.values(v).some(Boolean), )
log('checklist', JSON.stringify(checklist)) log('eligible', JSON.stringify(Array.from(eligible))) log('result', result)
return { checklist, eligible, result, }}
// The merge command must be on a separate line and not within codeblocks or html comments.// Codeblocks can have any number of ` larger than 3 to open/close. We only look at code// blocks that are not indented, because the later regex wouldn't match those anyway.function hasMergeCommand(body) { return (body ?? '') .replace(/<!--.*?-->/gms, '') .replace(/(^`{3,})[^`].*?\1/gms, '') .match(/^@NixOS\/nixpkgs-merge-bot merge\s*$/im)}
async function handleMergeComment({ github, body, node_id, reaction }) { if (!hasMergeCommand(body)) return
await github.graphql( `mutation($node_id: ID!, $reaction: ReactionContent!) { addReaction(input: { content: $reaction, subjectId: $node_id }) { clientMutationId } }`, { node_id, reaction }, )}
async function handleMerge({ github, context, core, log, dry, pull_request, events, maintainers, getTeamMembers, getUser,}) { const pull_number = pull_request.number
const committers = new Set( (await getTeamMembers('nixpkgs-committers')).map(({ id }) => id), )
const files = ( await github.rest.pulls.listFiles({ ...context.repo, pull_number, per_page: 100, }) ).data
// Early exit to prevent treewides from using up a lot of API requests (and time!) to list // all the files in the pull request. For now, the merge-bot will not work when 100 or more // files are touched in a PR - which should be more than fine. // TODO: Find a more efficient way of downloading all the *names* of the touched files, // including an early exit when the first non-by-name file is found. if (files.length >= 100) return false
// Only look through comments *after* the latest (force) push. const lastPush = events.findLastIndex( ({ event, sha, commit_id }) => ['committed', 'head_ref_force_pushed'].includes(event) && (sha ?? commit_id) === pull_request.head.sha, )
const comments = events.slice(lastPush + 1).filter( ({ event, body, user, node_id }) => ['commented', 'reviewed'].includes(event) && hasMergeCommand(body) && // Ignore comments where the user has been deleted already. user && // Ignore comments which had already been responded to by the bot. (dry || !events.some( ({ event, body }) => ['commented'].includes(event) && // We're only testing this hidden reference, but not the author of the comment. // We'll just assume that nobody creates comments with this marker on purpose. // Additionally checking the author is quite annoying for local debugging. body.match(new RegExp(`^<!-- comment: ${node_id} -->$`, 'm')), )), )
async function merge() { if (dry) { core.info(`Merging #${pull_number}... (dry)`) return ['Merge completed (dry)'] }
// Using GraphQL mutations instead of the REST /merge endpoint, because the latter // doesn't work with Merge Queues. We now have merge queues enabled on all development // branches, so we don't need a fallback for regular merges. try { const resp = await github.graphql( `mutation($node_id: ID!, $sha: GitObjectID) { enqueuePullRequest(input: { expectedHeadOid: $sha, pullRequestId: $node_id }) { clientMutationId, mergeQueueEntry { mergeQueue { url } } } }`, { node_id: pull_request.node_id, sha: pull_request.head.sha }, ) log('merge', 'Queued for merge') return [ `:heavy_check_mark: [Queued](${resp.enqueuePullRequest.mergeQueueEntry.mergeQueue.url}) for merge (#306934)`, ] } catch (e) { log('Enqueuing failed', e.response.errors[0].message) }
// If required status checks are not satisfied, yet, the above will fail. In this case // we can enable auto-merge. We could also only use auto-merge, but this often gets // stuck for no apparent reason. try { await github.graphql( `mutation($node_id: ID!, $sha: GitObjectID) { enablePullRequestAutoMerge(input: { expectedHeadOid: $sha, pullRequestId: $node_id }) { clientMutationId } }`, { node_id: pull_request.node_id, sha: pull_request.head.sha }, ) log('merge', 'Auto-merge enabled') return [ `:heavy_check_mark: Enabled Auto Merge (#306934)`, '', '> [!TIP]', '> Sometimes GitHub gets stuck after enabling Auto Merge. In this case, leaving another approval should trigger the merge.', ] } catch (e) { log('Auto Merge failed', e.response.errors[0].message) throw new Error(e.response.errors[0].message) } }
for (const comment of comments) { log('comment', comment.node_id)
async function react(reaction) { if (dry) { core.info(`Reaction ${reaction} on ${comment.node_id} (dry)`) return }
await handleMergeComment({ github, body: comment.body, node_id: comment.node_id, reaction, }) }
async function isMaintainer(username) { try { return ( ( await github.rest.teams.getMembershipForUserInOrg({ org: context.repo.owner, team_slug: 'nixpkgs-maintainers', username, }) ).data.state === 'active' ) } catch (e) { if (e.status === 404) return false else throw e } }
const { result, eligible, checklist } = runChecklist({ committers, events, files, pull_request, log, maintainers, user: comment.user, userIsMaintainer: await isMaintainer(comment.user.login), })
const body = [ `<!-- comment: ${comment.node_id} -->`, `@${comment.user.login} wants to merge this PR.`, '', 'Requirements to merge this PR with `@NixOS/nixpkgs-merge-bot merge`:', ...Object.entries(checklist).flatMap(([msg, res]) => typeof res === 'boolean' ? `- :${res ? 'white_check_mark' : 'x'}: ${msg}` : [ `- :${Object.values(res).some(Boolean) ? 'white_check_mark' : 'x'}: ${msg}`, ...Object.entries(res).map( ([msg, res]) => ` - ${res ? ':white_check_mark:' : ':white_large_square:'} ${msg}`, ), ], ), '', ]
if (eligible.size > 0 && !eligible.has(comment.user.id)) { const users = await Promise.all( Array.from(eligible, async (id) => (await getUser(id)).login), ) body.push( '> [!TIP]', '> Maintainers eligible to merge are:', ...users.map((login) => `> - ${login}`), '', ) }
if (result) { await react('ROCKET') try { body.push(...(await merge())) } catch (e) { // Remove the HTML comment with node_id reference to allow retrying this merge on the next run. body.shift() body.push(`:x: Merge failed with: ${e} (#371492)`) } } else { await react('THUMBS_DOWN') body.push(':x: Pull Request could not be merged (#305350)') }
if (dry) { core.info(body.join('\n')) } else { await github.rest.issues.createComment({ ...context.repo, issue_number: pull_number, body: body.join('\n'), }) }
if (result) break }
const { result } = runChecklist({ committers, events, files, pull_request, log, maintainers, })
// Returns a boolean, which indicates whether the PR is merge-bot eligible in principle. // This is used to set the respective label in bot.js. return result}
module.exports = { handleMerge, handleMergeComment,}