|
| 1 | +name: Check unallowed file changes |
| 2 | + |
| 3 | +on: |
| 4 | + push: |
| 5 | + |
| 6 | +jobs: |
| 7 | + triage: |
| 8 | + if: github.repository == 'github/docs' && github.event.pull_request.user.login != 'Octomerger' |
| 9 | + runs-on: ubuntu-latest |
| 10 | + steps: |
| 11 | + - uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f |
| 12 | + - name: Get pull request number |
| 13 | + id: pull-number |
| 14 | + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 |
| 15 | + with: |
| 16 | + github-token: ${{secrets.GITHUB_TOKEN}} |
| 17 | + result-encoding: string |
| 18 | + script: | |
| 19 | + const pulls = await github.repos.listPullRequestsAssociatedWithCommit({ |
| 20 | + ...context.repo, |
| 21 | + commit_sha: context.sha |
| 22 | + }) |
| 23 | +
|
| 24 | + return pulls.data.map(pull => pull.number).shift() |
| 25 | + - name: Check for existing requested changes |
| 26 | + id: requested-change |
| 27 | + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 |
| 28 | + with: |
| 29 | + github-token: ${{secrets.GITHUB_TOKEN}} |
| 30 | + result-encoding: json |
| 31 | + script: | |
| 32 | + const pullReviews = await github.pulls.listReviews({ |
| 33 | + ...context.repo, |
| 34 | + pull_number: ${{steps.pull-number.outputs.result}} |
| 35 | + }) |
| 36 | +
|
| 37 | + return pullReviews.data |
| 38 | + .filter(review => review.user.login === 'github-actions[bot]') |
| 39 | + .sort((a, b) => new Date(b.submitted_at) - new Date(a.submitted_at)) |
| 40 | + .shift() |
| 41 | + - name: Get files changed |
| 42 | + uses: dorny/paths-filter@eb75a1edc117d3756a18ef89958ee59f9500ba58 |
| 43 | + id: filter |
| 44 | + with: |
| 45 | + # Base branch used to get changed files |
| 46 | + base: 'main' |
| 47 | + |
| 48 | + # Enables setting an output in the format in `${FILTER_NAME}_files |
| 49 | + # with the names of the matching files formatted as JSON array |
| 50 | + list-files: json |
| 51 | + |
| 52 | + # Returns list of changed files matching each filter |
| 53 | + filters: | |
| 54 | + translation: |
| 55 | + - 'translations/**' |
| 56 | + openapi: |
| 57 | + - 'lib/rest/static/**' |
| 58 | + notAllowed: |
| 59 | + - '.github/workflows/**' |
| 60 | + - '.github/CODEOWNERS' |
| 61 | + - 'translations/**' |
| 62 | + - 'assets/fonts/**' |
| 63 | + - 'data/graphql/**' |
| 64 | + - 'lib/graphql/**' |
| 65 | + - 'lib/redirects/**' |
| 66 | + - 'lib/rest/**' |
| 67 | + - 'lib/webhooks/**' |
| 68 | +
|
| 69 | + # When there are changes to files we can't accept |
| 70 | + # and no review exists,leave a REQUEST_CHANGES review |
| 71 | + - name: Request pull request changes |
| 72 | + # Check for no reviews or reviews that aren't CHANGES_REQUESTED |
| 73 | + if: ${{ steps.filter.outputs.notAllowed == 'true' && (!steps.requested-change.outputs.result || fromJson(steps.requested-change.outputs.result).state != 'CHANGES_REQUESTED') }} |
| 74 | + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 |
| 75 | + with: |
| 76 | + github-token: ${{secrets.GITHUB_TOKEN}} |
| 77 | + script: | |
| 78 | + const changedFiles = ${{steps.filter.outputs.notAllowed_files}} |
| 79 | + const restFiles = ${{steps.filter.outputs.openapi_files}} |
| 80 | + const translationFiles = ${{steps.filter.outputs.translation_files}} |
| 81 | + const markdownFiles = changedFiles.map(file => `- \`${file}\`\n`).join('') |
| 82 | +
|
| 83 | + let reviewMessage = `👋 Hey there spelunker. It looks like you've modified some files that we can't accept as contributions.\n${markdownFiles}\n\nYou'll need to revert all of these ☝️ files using [GitHub Desktop](https://docs.github.com/en/free-pro-team@latest/desktop/contributing-and-collaborating-using-github-desktop/reverting-a-commit) or \`git checkout origin/main <file name>\`. Once you get those files reverted, we can continue with the review process. :octocat:` |
| 84 | +
|
| 85 | + if (restFiles.length > 0) { |
| 86 | + reviewMessage += "\n\nIt looks like you've modified the OpenAPI schema (`lib/rest/static/**`). While we aren't accepting changes to the schema directly, you can open an issue for any updates to the REST API docs. Head on over to the [`github/rest-api-description`](https://github.com/github/rest-api-description/issues/new?assignees=&labels=Inaccuracy&template=schema-inaccuracy.md&title=%5BSchema+Inaccuracy%5D+%3CDescribe+Problem%3E) repository to open an issue. ⚡" |
| 87 | + } |
| 88 | +
|
| 89 | + if (translationFiles.length > 0) { |
| 90 | + await github.issues.addLabels({ |
| 91 | + ...context.repo, |
| 92 | + issue_number: ${{steps.pull-number.outputs.result}}, |
| 93 | + labels: ['localization'] |
| 94 | + }) |
| 95 | + reviewMessage += "\n\nIt looks like you've modified translated content. Unfortunately, we are not able to accept pull requests for translated content. Our translation process involves an integration with an external service at crowdin.com, where all translation activity happens. We hope to eventually open up the translation process to the open source community, but we're not there yet. See https://github.com/github/docs/blob/main/CONTRIBUTING.md#earth_asia-translations for more details." |
| 96 | + } |
| 97 | +
|
| 98 | + await github.pulls.createReview({ |
| 99 | + ...context.repo, |
| 100 | + pull_number: ${{steps.pull-number.outputs.result}}, |
| 101 | + body: reviewMessage, |
| 102 | + event: 'REQUEST_CHANGES' |
| 103 | + }) |
| 104 | + # When the most recent review was CHANGES_REQUESTED and the existing |
| 105 | + # PR no longer contains unallowed changes, dismiss the previous review |
| 106 | + - name: Dismiss pull request review |
| 107 | + if: ${{ steps.filter.outputs.notAllowed == 'false' && fromJson(steps.requested-change.outputs.result).state == 'CHANGES_REQUESTED' }} |
| 108 | + uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9 |
| 109 | + with: |
| 110 | + github-token: ${{secrets.GITHUB_TOKEN}} |
| 111 | + script: | |
| 112 | + await github.pulls.dismissReview({ |
| 113 | + ...context.repo, |
| 114 | + pull_number: ${{steps.pull-number.outputs.result}}, |
| 115 | + review_id: ${{fromJson(steps.requested-change.outputs.result).id}}, |
| 116 | + message: `✨Looks like you reverted all files we don't accept contributions for. 🙌 A member of the docs team will review your PR soon. 🚂` |
| 117 | + }) |
0 commit comments