Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/vitest-dev/vitest. Next generation testing framework powered by Vite. vitest.dev
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283const POLICY_MARKER = '<!-- vitest-pr-redirect -->'const DUPLICATE_MARKER = '<!-- vitest-pr-redirect:duplicate -->'const APPROVED_LABEL = 'approved'
function createRedirect({ github, context, core }) { const { owner, repo } = context.repo const policyUrl = `https://github.com/${owner}/${repo}/blob/main/CONTRIBUTING.md#pull-request-policy`
// closing keywords can point to any repository function isInRepository(node) { return node?.repository.nameWithOwner.toLowerCase() === `${owner}/${repo}`.toLowerCase() }
// a missing list fails the run, an empty list would close the PRs of every approved contributor async function readApprovedContributors() { const { data: file } = await github.rest.repos.getContent({ owner, repo, path: 'APPROVED_CONTRIBUTORS', // the full name, a tag with the same name must not replace the branch ref: 'refs/heads/approved-contributors', }) const ids = new Set() for (const line of Buffer.from(file.content, 'base64').toString('utf8').split('\n')) { // the login after `#` is only for readers, another account can take a login after a rename const id = /^(\d+)(?: *#.*)?$/.exec(line.trim())?.[1] if (id) { ids.add(Number(id)) } } return ids }
const writeAccess = new Map() async function hasWriteAccess(username) { if (!writeAccess.has(username)) { const { data } = await github.rest.repos.getCollaboratorPermissionLevel({ owner, repo, username, }) writeAccess.set(username, ['admin', 'write'].includes(data.permission)) } return writeAccess.get(username) }
const mergedPullRequests = new Map() async function hasMergedPullRequest(login) { if (!mergedPullRequests.has(login)) { const { search } = await github.graphql( `query ($search: String!) { search(query: $search, type: ISSUE, first: 1) { issueCount } }`, { search: `repo:${owner}/${repo} is:pr is:merged author:${login}` }, ) mergedPullRequests.set(login, search.issueCount > 0) } return mergedPullRequests.get(login) }
async function findReasonToSkip(pr, approved) { // anyone can open a PR between two branches of this repository, only an installed app is trusted here if (pr.head.repo?.full_name === `${owner}/${repo}` && pr.user.type === 'Bot') { return 'opened by an app from a branch in this repository' } if ( ['OWNER', 'MEMBER', 'COLLABORATOR'].includes(pr.author_association) || (await hasWriteAccess(pr.user.login)) ) { return 'the author is a team member' } if (approved.has(pr.user.id)) { return 'the author is an approved contributor' } // a merged PR vouches for a person, not for an app if (pr.user.type === 'User' && (await hasMergedPullRequest(pr.user.login))) { return 'the author has a merged pull request' } return null }
async function findLinkedIssues(pr) { const { repository } = await github.graphql( `query ($owner: String!, $repo: String!, $number: Int!) { repository(owner: $owner, name: $repo) { pullRequest(number: $number) { closingIssuesReferences(first: 10) { nodes { number state repository { nameWithOwner } labels(first: 100) { nodes { name } } closedByPullRequestsReferences(first: 100) { nodes { number state repository { nameWithOwner } } } } } } } }`, { owner, repo, number: pr.number }, ) return repository.pullRequest.closingIssuesReferences.nodes.filter(isInRepository) }
function createComment(marker, pr, lines) { const body = [ marker, `Hello @${pr.user.login}. Thank you for taking the time to contribute!`, '', ...lines, ].join('\n') return { marker, body } }
async function checkLinkedIssues(pr, { reopened }) { const issues = await findLinkedIssues(pr) const approvedIssues = issues.filter( (issue) => issue.state === 'OPEN' && issue.labels.nodes.some((label) => label.name === APPROVED_LABEL), ) for (const issue of approvedIssues) { const others = issue.closedByPullRequestsReferences.nodes.filter( (other) => isInRepository(other) && other.state === 'OPEN' && other.number !== pr.number && // a reopened PR must not replace the PR that was opened while it was closed (reopened || other.number < pr.number), ) if (others.length) { const list = others.map((other) => `#${other.number}`).join(', ') return createComment(DUPLICATE_MARKER, pr, [ `The team accepts one pull request per issue, and #${issue.number} already has an open pull request (${list}), so this pull request was closed automatically. If you think that your approach is better, please explain why in #${issue.number}.`, '', `Your changes are not lost: a maintainer can reopen this pull request if the team decides to go forward with it. See our [pull request policy](${policyUrl}) for more context.`, ]) } } if (approvedIssues.length) { return { reason: `it fixes the approved issue #${approvedIssues[0].number}` } } const nextStep = issues.length ? `Please keep the discussion in ${issues.map((issue) => `#${issue.number}`).join(', ')}.` : `If there is no issue for this change yet, please [open one](https://github.com/${owner}/${repo}/issues/new/choose) to discuss it with the team first.` return createComment(POLICY_MARKER, pr, [ `Unfortunately, the team accepts pull requests only from maintainers, from anyone who contributed before, from approved contributors, or for issues with the \`${APPROVED_LABEL}\` label, so this pull request was closed automatically. We are sorry about that, it is not a judgement of your work. The number of pull requests grew beyond what the team can review, and this policy gives maintainers the space to triage and prioritize issues at their own pace.`, '', `${nextStep} Your changes are not lost: a maintainer can reopen this pull request if the team decides to go forward with it. See our [pull request policy](${policyUrl}) for more context.`, ]) }
async function findRedirectMarkers(pr) { const comments = await github.paginate(github.rest.issues.listComments, { owner, repo, issue_number: pr.number, per_page: 100, }) return new Set( [POLICY_MARKER, DUPLICATE_MARKER].filter((marker) => comments.some( (comment) => comment.user?.login === 'github-actions[bot]' && comment.body?.includes(marker), ), ), ) }
async function close(pr, comment) { if (comment) { await github.rest.issues.createComment({ owner, repo, issue_number: pr.number, body: comment.body, }) } await github.rest.pulls.update({ owner, repo, pull_number: pr.number, state: 'closed' }) core.info(`#${pr.number} by @${pr.user.login} is closed`) }
return { readApprovedContributors, hasWriteAccess, findReasonToSkip, checkLinkedIssues, findRedirectMarkers, close, }}
/** * Closes a pull request that does not follow the "Pull Request Policy" in CONTRIBUTING.md * and asks the author to discuss the change in an issue. */export default async function redirectPullRequest({ github, context, core }) { const redirect = createRedirect({ github, context, core }) const pr = context.payload.pull_request
const { owner, repo } = context.repo const { data: current } = await github.rest.pulls.get({ owner, repo, pull_number: pr.number }) if (current.state !== 'open') { core.info(`#${pr.number} is skipped: already closed`) return }
const reopened = context.payload.action === 'reopened' const approved = await redirect.readApprovedContributors() let reason = await redirect.findReasonToSkip(pr, approved) if (!reason && reopened && (await redirect.hasWriteAccess(context.payload.sender.login))) { reason = 'a maintainer reopened it' } const result = reason ? { reason } : await redirect.checkLinkedIssues(pr, { reopened }) if (result.reason) { core.info(`#${pr.number} is skipped: ${result.reason}`) return } // a PR reopened by its author gets the same comment only once const markers = await redirect.findRedirectMarkers(pr) await redirect.close(pr, markers.has(result.marker) ? null : result)}
/** * Closes every open pull request that does not follow the "Pull Request Policy" in CONTRIBUTING.md. */export async function redirectOpenPullRequests({ github, context, core }) { const redirect = createRedirect({ github, context, core }) const { owner, repo } = context.repo const dryRun = process.env.DRY_RUN === 'true'
const approved = await redirect.readApprovedContributors() const pulls = await github.paginate(github.rest.pulls.list, { owner, repo, state: 'open', sort: 'created', direction: 'asc', per_page: 100, })
let closed = 0 let failures = 0 for (const pr of pulls) { // a PR that cannot be processed stays open and must not block the other PRs try { let reason = await redirect.findReasonToSkip(pr, approved) // the event workflow checks a PR again when someone reopens it if (!reason && (await redirect.findRedirectMarkers(pr)).size) { reason = 'it was reopened after a redirect' } const result = reason ? { reason } : await redirect.checkLinkedIssues(pr, { reopened: false }) if (result.reason) { core.info(`#${pr.number} is skipped: ${result.reason}`) continue } closed++ if (dryRun) { core.info(`#${pr.number} by @${pr.user.login} would be closed`) continue } await redirect.close(pr, result) // GitHub limits how fast a token can create content await new Promise((resolve) => setTimeout(resolve, 2000)) } catch (error) { failures++ core.error(`#${pr.number} failed: ${error.message}`) } } core.notice(`${dryRun ? 'Would close' : 'Closed'} ${closed} of ${pulls.length} open PRs`) if (failures) { core.setFailed(`Cannot process ${failures} PRs`) }}