|
| 1 | +#!/usr/bin/env node |
| 2 | + |
| 3 | +import { getOctokit } from '@actions/github' |
| 4 | +const token = process.env.GITHUB_TOKEN |
| 5 | +const github = getOctokit(token) |
| 6 | + |
| 7 | +// Mergeable status documentation here: |
| 8 | +// https://docs.github.com/en/graphql/reference/enums#mergestatestatus |
| 9 | +// https://docs.github.com/en/graphql/reference/enums#mergeablestate |
| 10 | + |
| 11 | +/* |
| 12 | + This script gets a list of automerge-enabled PRs and sorts them |
| 13 | + by priority. The PRs with the skip-to-front-of-merge-queue label |
| 14 | + are prioritized first. The rest of the PRs are sorted by the date |
| 15 | + they were updated. This is basically a FIFO queue, while allowing |
| 16 | + writers the ability to skip the line when high-priority ships are |
| 17 | + needed but a freeze isn't necessary. |
| 18 | +*/ |
| 19 | + |
| 20 | +main() |
| 21 | + |
| 22 | +async function main() { |
| 23 | + // Get a list of open PRs and order them from oldest to newest |
| 24 | + const query = `query ($first: Int, $after: String, $firstLabels: Int) { |
| 25 | + organization(login: "github") { |
| 26 | + repository(name: "docs-internal") { |
| 27 | + pullRequests(first: $first, after: $after, states: OPEN, orderBy: {field: UPDATED_AT, direction: ASC}) { |
| 28 | + edges{ |
| 29 | + node { |
| 30 | + number |
| 31 | + url |
| 32 | + updatedAt |
| 33 | + mergeable |
| 34 | + mergeStateStatus |
| 35 | + autoMergeRequest { |
| 36 | + enabledBy { |
| 37 | + login |
| 38 | + } |
| 39 | + enabledAt |
| 40 | + } |
| 41 | + labels (first:$firstLabels){ |
| 42 | + nodes { |
| 43 | + name |
| 44 | + } |
| 45 | + } |
| 46 | + } |
| 47 | + } |
| 48 | + pageInfo { |
| 49 | + hasNextPage |
| 50 | + endCursor |
| 51 | + } |
| 52 | + } |
| 53 | + } |
| 54 | + } |
| 55 | + }` |
| 56 | + |
| 57 | + const queryVariables = { |
| 58 | + first: 100, |
| 59 | + after: null, // when pagination in null it will get first page |
| 60 | + firstLabels: 100, |
| 61 | + headers: { |
| 62 | + // required for the mergeStateStatus enum |
| 63 | + accept: 'application/vnd.github.merge-info-preview+json', |
| 64 | + }, |
| 65 | + } |
| 66 | + let hasNextPage = true |
| 67 | + const autoMergeEnabledPRs = [] |
| 68 | + |
| 69 | + // we need to get all the paginated results in the case that |
| 70 | + // there are more than 100 PRs |
| 71 | + while (hasNextPage) { |
| 72 | + const graph = await github.graphql(query, queryVariables) |
| 73 | + const dataRoot = graph.organization.repository.pullRequests |
| 74 | + const pullRequests = dataRoot.edges |
| 75 | + // update pagination variables |
| 76 | + hasNextPage = dataRoot.pageInfo.hasNextPage |
| 77 | + // the endCursor is the start cursor for the next page |
| 78 | + queryVariables.after = dataRoot.pageInfo.endCursor |
| 79 | + |
| 80 | + const filteredPrs = pullRequests |
| 81 | + // this simplifies the format received from the graphql query to |
| 82 | + // remove the unnecessary nested objects |
| 83 | + .map((pr) => { |
| 84 | + // make the labels object just an array of the label names |
| 85 | + const labelArray = pr.node.labels.nodes.map((label) => label.name) |
| 86 | + pr.node.labels = labelArray |
| 87 | + // return the pr object and ✂️ the node property |
| 88 | + return pr.node |
| 89 | + }) |
| 90 | + .filter((pr) => pr.autoMergeRequest !== null) |
| 91 | + .filter((pr) => pr.mergeable === 'MERGEABLE') |
| 92 | + // filter out prs that don't have a calculated mergeable state yet |
| 93 | + .filter((pr) => pr.mergeStateStatus !== 'UNKNOWN') |
| 94 | + // filter out prs that still need a review, have merge conflicts, |
| 95 | + // or have failing ci tests |
| 96 | + .filter((pr) => pr.mergeStateStatus !== 'BLOCKED') |
| 97 | + // **NOTE**: In the future we may want to send slack message to initiators |
| 98 | + // of PRs with the following merge states because these can happen after |
| 99 | + // a PR is green and the automerge is enabled |
| 100 | + .filter((pr) => pr.mergeStateStatus !== 'DIRTY') |
| 101 | + .filter((pr) => pr.mergeStateStatus !== 'UNSTABLE') |
| 102 | + |
| 103 | + autoMergeEnabledPRs.push(...filteredPrs) |
| 104 | + } |
| 105 | + |
| 106 | + // Get the list of prs with the skip label so they can |
| 107 | + // be put at the beginning of the list |
| 108 | + const prioritizedPrList = autoMergeEnabledPRs |
| 109 | + .filter((pr) => pr.labels.includes('skip-to-front-of-merge-queue')) |
| 110 | + .concat(autoMergeEnabledPRs.filter((pr) => !pr.labels.includes('skip-to-front-of-merge-queue'))) |
| 111 | + |
| 112 | + const nextInQueue = prioritizedPrList.shift() |
| 113 | + // Update the branch for the next PR in the merge queue |
| 114 | + github.rest.pulls.updateBranch({ |
| 115 | + owner: 'github', |
| 116 | + repo: 'docs-internal', |
| 117 | + pull_number: parseInt(nextInQueue.number), |
| 118 | + }) |
| 119 | + |
| 120 | + console.log(`⏱ Total PRs in the merge queue: ${prioritizedPrList.length + 1}`) |
| 121 | + console.log(`🚂 Updated branch for PR #${JSON.stringify(nextInQueue, null, 2)}`) |
| 122 | + console.log(`🚏 Next up in the queue: `) |
| 123 | + console.log(JSON.stringify(prioritizedPrList, null, 2)) |
| 124 | +} |
0 commit comments