notify-when-maintainers-cannot-edit.yaml

name: Notify When Maintainers Cannot Edit

# Public PR authors get a maintainer-edit notice without maintainers checking
# the fork setting manually.

on:
  # pull_request_target lets forked PRs receive the maintainer-edit notice.
  pull_request_target:
    types:
      - opened

permissions:
  contents: read
  pull-requests: write

jobs:
  notify-when-maintainers-cannot-edit:
    if: github.repository == 'github/docs'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3
        with:
          script: |
            const query = `
              query($number: Int!) {
                repository(owner: "github", name: "docs") {
                  pullRequest(number: $number) {
                    headRepositoryOwner {
                      login
                    }
                    maintainerCanModify
                  }
                }
              }
            `;

            const pullNumber = context.issue.number;
            const variables = { number: pullNumber };

            try {
              console.log(`Check github/docs#${pullNumber} for maintainer edit access ...`);
              const result = await github.graphql(query, variables);

              console.log(JSON.stringify(result, null, 2));

              const pullRequest = result.repository.pullRequest;

              if (pullRequest.headRepositoryOwner.login === 'github') {
                console.log('PR owned by github');
                return;
              }

              if (!pullRequest.maintainerCanModify) {
                console.log('PR not owned by github and does not have maintainer edits enabled');

                await github.rest.issues.createComment({
                  issue_number: pullNumber,
                  owner: 'github',
                  repo: 'docs',
                  body: "Thanks for submitting a PR to the GitHub Docs project!\n\nIn order to review and merge PRs most efficiently, we require that all PRs grant maintainer edit access before we review them. For information on how to do this, [see the documentation](https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)."
                });
              }
            } catch(e) {
              console.log(e);
            }