docs/.github/workflows/changelog-prompt.yml at 885273624a70647c8ce46a1953859b6793554da5 · github/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
name: Changelog prompt when a PR is closed

on:
  pull_request:
    types: [closed]

permissions:
  contents: read
  pull-requests: write

jobs:
  comment-on-pr:
    # This workflow should only run on the 'github/docs-internal' repository because it posts changelog instructions
    # and links that are specific to the internal documentation process and resources.
    # It also only runs if PR is merged into the main branch.
    if: github.repository == 'github/docs-internal' && github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main'

    runs-on: ubuntu-latest

    steps:
      - name: Check if PR author is in docs-content team
        id: check_team
        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
        with:
          github-token: ${{ secrets.DOCS_BOT_PAT_BASE }}
          script: |
            try {
              const pr = context.payload.pull_request;
              await github.rest.teams.getMembershipForUserInOrg({
                org: 'github',
                team_slug: 'docs-content',
                username: pr.user.login,
              });
              core.exportVariable('CONTINUE_WORKFLOW', 'true');
            } catch(err) {
              core.info("Workflow triggered by a merged PR, but the PR author is not a member of the docs-content team.");
              core.exportVariable('CONTINUE_WORKFLOW', 'false');
            }

      - name: Post changelog instructions comment

        if: env.CONTINUE_WORKFLOW == 'true'

        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
        with:
          github-token: ${{ secrets.DOCS_BOT_PAT_BASE }}
          script: |
            // Get PR author username
            const pr = context.payload.pull_request;
            const prAuthor = pr.user.login;

            // Compose the comment body with readable YAML and correct formatting
            const commentBody =
              "👋 @" + prAuthor +
              " - Did this PR add noteworthy changes to the GitHub docs? If so, you might want to publicize this by adding an entry to " +
              "the [Docs changelog](https://github.com/github/docs-internal/blob/main/CHANGELOG.md).\n\n" +
              "To do this, type `/changelog` in a new comment on this PR and complete the fields.\n\n" +
              "A message will be posted to the **#docs-changelog** channel and a PR will be raised to update the [CHANGELOG.md](https://github.com/github/docs-internal/blob/main/CHANGELOG.md) file.";

            // Post the comment
            await github.rest.issues.createComment({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: pr.number,
              body: commentBody
            });