too_many_good_first_prs.yml

#/
# @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: too_many_good_first_prs

# Workflow triggers:
on:
  pull_request_target:
    types:
      - opened

# Workflow jobs:
jobs:

  # Define a job which encourages contributors opening too many "Good First PRs" to tackle more challenging problems:
  check_num_good_first_prs:

    # Define job name:
    name: 'Check if contributor has opened too many "Good First PRs"'

    # Only run this job if the pull request did not have label `automated-pr` and is not from bots:
    if: >
      contains(github.event.pull_request.labels.*.name, 'automated-pr') == false &&
      github.event.pull_request.user.login != 'stdlib-bot' &&
      github.event.pull_request.user.login != 'dependabot[bot]'

    # Define job permissions:
    permissions:
      contents: read
      pull-requests: write

    # 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@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          # Specify whether to remove untracked files before checking out the repository:
          clean: true

          # Limit clone depth to the most recent commit:
          fetch-depth: 1

          # Specify whether to download Git-LFS files:
          lfs: false
        timeout-minutes: 10

      # Prevent contributors from opening too many "Good First PR"s:
      - name: 'Prevent contributors from opening too many "Good First PR"s'
        env:
          PR_NUMBER: ${{ github.event.pull_request.number }}
          GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
        run: |
          . "$GITHUB_WORKSPACE/.github/workflows/scripts/rate_limit_contributions" $PR_NUMBER