content/.github/workflows/pr-reviewdog.yml at 0bd99260a605fec40b453f2e6178f15b0b2a6c03 · ryrodriguez25/content · 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
name: PR Reviewdog

on:
  workflow_run:
    workflows:
      - "Lint content"
    types:
      - completed

permissions:
  # Download artifact from lint workflow.
  actions: read
  # Post inline review comments via reviewdog.
  pull-requests: write
  # Report commit status.
  statuses: write

jobs:
  reviewdog:
    runs-on: ubuntu-latest
    env:
      STATUS_PATH: repos/${{ github.repository }}/statuses/${{ github.event.workflow_run.head_sha }}
      STATUS_CONTEXT: ${{ github.workflow }}
      STATUS_TARGET: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
    steps:
      - name: Mark status as pending
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          gh api "$STATUS_PATH" \
            -f state=pending \
            -f context="$STATUS_CONTEXT" \
            -f description='Running' \
            -f target_url="$STATUS_TARGET"

      - name: Identify PR
        id: identify-pr
        env:
          BASE_REPO: ${{ github.repository }}
          GITHUB_TOKEN: ${{ github.token }}
          HEAD_REPO: ${{ github.event.workflow_run.head_repository.full_name }}
          HEAD_SHA: ${{ github.event.workflow_run.head_sha }}
        run: |
          PR_NUMBER=$(gh api "repos/$HEAD_REPO/commits/$HEAD_SHA/pulls" \
            --jq ".[] | select(.base.repo.full_name == \"$BASE_REPO\") | .number")
          echo "number=$PR_NUMBER" >> $GITHUB_OUTPUT

      - name: Download artifact
        if: steps.identify-pr.outputs.number
        continue-on-error: true
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: lint-results
          path: lint-results
          github-token: ${{ secrets.GITHUB_TOKEN }}
          run-id: ${{ github.event.workflow_run.id }}

      - name: Check for artifact
        id: check
        if: steps.identify-pr.outputs.number && hashFiles('lint-results/') != ''
        run: echo "HAS_ARTIFACT=true" >> "$GITHUB_OUTPUT"

      - name: Checkout
        if: steps.identify-pr.outputs.number
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          path: mdn-content
          ref: main
          persist-credentials: false

      - name: Setup reviewdog
        if: steps.check.outputs.HAS_ARTIFACT == 'true'
        uses: reviewdog/action-setup@d8a7baabd7f3e8544ee4dbde3ee41d0011c3a93f # v1.5.0
        with:
          reviewdog_version: latest

      - name: Add PR review with suggested changes using `git diff` output
        if: steps.check.outputs.HAS_ARTIFACT == 'true' && hashFiles('lint-results/lint.diff') != ''
        working-directory: mdn-content
        env:
          CI_PULL_REQUEST: ${{ steps.identify-pr.outputs.number }}
          CI_COMMIT: ${{ github.event.workflow_run.head_sha }}
          CI_REPO_OWNER: ${{ github.repository_owner }}
          CI_REPO_NAME: ${{ github.event.repository.name }}
          CI_BRANCH: ${{ github.event.workflow_run.head_branch }}
          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          env -u GITHUB_ACTIONS reviewdog \
            -guess \
            -name="mdn-linter" \
            -f=diff \
            -f.diff.strip=1 \
            -filter-mode=diff_context \
            -reporter=github-pr-review < ../lint-results/lint.diff

      - name: Add PR review with comments for errors in markdownlint output
        if: steps.check.outputs.HAS_ARTIFACT == 'true' && hashFiles('lint-results/markdownlint.log') != ''
        working-directory: mdn-content
        env:
          CI_PULL_REQUEST: ${{ steps.identify-pr.outputs.number }}
          CI_COMMIT: ${{ github.event.workflow_run.head_sha }}
          CI_REPO_OWNER: ${{ github.repository_owner }}
          CI_REPO_NAME: ${{ github.event.repository.name }}
          CI_BRANCH: ${{ github.event.workflow_run.head_branch }}
          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          env -u GITHUB_ACTIONS reviewdog \
            -efm="%f:%l:%c %m" \
            -efm="%f:%l %m" \
            -name="markdownlint" \
            -diff="git diff" \
            -reporter="github-pr-review" < ../lint-results/markdownlint.log

      - name: Mark status as success
        if: success()
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          gh api "$STATUS_PATH" \
            -f state=success \
            -f context="$STATUS_CONTEXT" \
            -f description='Successful' \
            -f target_url="$STATUS_TARGET"

      - name: Mark status as failure
        if: failure()
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          gh api "$STATUS_PATH" \
            -f state=failure \
            -f context="$STATUS_CONTEXT" \
            -f description='Failing' \
            -f target_url="$STATUS_TARGET"