Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
user-check

GitHub Action

pull-requester

v1.1.0

pull-requester

user-check

pull-requester

A GitHub Action for running standard checks and automations on pull requests for the n3tuk Organisation

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: pull-requester

              
  uses: n3tuk/[email protected]
Learn more about this action in n3tuk/action-pull-requester

Choose a version

n3tuk Pull Request Checker

GitHub go-integrations Workflow Status GitHub codeql Workflow Status GitHub go-releaser Workflow Status Codecov Status

A GitHub Action for running standard checks and automations on pull requests for the n3tuk Organisation.

Usage

You can use the pull-requester GitHub Action in a GitHub Workflow by configuring a YAML file in your GitHub repository (under .github/workflows/pull-requester.yaml), with the following contents:

---
name: Pull Requester

on:
  pull_request:
    types:
      - opened
      - reopened
      - synchronize
      - edited
      # Catch when added labels are forcefully removed
      - unlabeled
    branches:
      - main

permissions:
  contents: read
  packages: read
  issues: write
  pull-requests: write

jobs:
  pull-requester:
    runs-on: ubuntu-latest
    name: Check the Pull Request

    concurrency:
      # Ensure that GitHub runs a single concurrent job for any Pull Requester
      # event on any one pull request (i.e. github.event.number), and bias that
      # to the latest job started, which will have access to the latest settings
      group: pull-requester-${{ github.event.number }}
      cancel-in-progress: true

    steps:
      - name: Pull Requester
        uses: n3tuk/action-pull-requester@v1

Note: Do not use the main branch (or any other branch) as a reference for the GitHub Action, as the binaries for the GitHub Action builds and releases on tagging, and the Action downloads those on running.

Inputs

Name Description Required Type Default
title-minimum The minimum number of characters that a title should contain false int 25
label-prefixes A comma-separated list of label prefixes to check for on a pull request false string ''
label-prefixes-any Set that any label prefix can match to pass, rather than all false bool `false'