stdlib/.github/workflows/label_good_first_prs.yml at develop · ByteKnight28/stdlib · 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
#/
# @license Apache-2.0
#
# Copyright (c) 2025 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#/

# Workflow name:
name: label_good_first_prs

# Workflow triggers:
on:
  pull_request_target:
    types:
      - opened
      - closed
      - synchronize
      - reopened
      - edited

# Workflow jobs:
jobs:

  # Define a job which automatically labels pull requests based on whether they reference good first issues
  labeler:

    # Define job name:
    name: 'Label PRs for issues with label "Good First Issue" as "Good First PR"s'

    # Only run this job if the pull request did not have label `automated-pr`:
    if: contains(github.event.pull_request.labels.*.name, 'automated-pr') == false

    # Define job permissions:
    permissions:
      # Allow read-only access to the repository contents:
      contents: read

    # Define the type of virtual host machine:
    runs-on: ubuntu-latest

    # Define the sequence of job steps:
    steps:
      # Checkout the repository:
      - name: 'Checkout repository'
        # Pin action to full length commit SHA
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          # Ensure we have access to the scripts directory:
          sparse-checkout: |
              .github/workflows/scripts
          sparse-checkout-cone-mode: false
        timeout-minutes: 10

      # Check whether any of the referenced issues is a "Good First Issue":
      - name: 'Check whether any of the referenced issues is a "Good First Issue"'
        id: 'check-pr'
        env:
          PR_NUMBER: ${{ github.event.pull_request.number }}
        run: |
          bool=$(. "$GITHUB_WORKSPACE/.github/workflows/scripts/label_good_first_prs/references_good_first_issue" $PR_NUMBER)
          echo "good-first-pr=$bool" >> $GITHUB_OUTPUT

      # Add "Good First PR" label if PR references a "Good First Issue"
      - name: 'Add "Good First PR" label if PR references a "Good First Issue"'
        if: ${{ steps.check-pr.outputs.good-first-pr == 'true' }}
        # Pin action to full-length commit SHA
        uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v8.0.0
        with:
          github-token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
          script: |
            const { data: pr } = await github.rest.pulls.get({
              'owner': context.repo.owner,
              'repo': context.repo.repo,
              'pull_number': context.payload.pull_request.number
            });
            const labels = context.payload.pull_request.labels.map( label => label.name );
            if ( !labels.includes( 'Good First PR' ) ) {
              await github.rest.issues.addLabels({
                'owner': context.repo.owner,
                'repo': context.repo.repo,
                'issue_number': context.payload.pull_request.number,
                'labels': [ 'Good First PR' ]
              });
            }