Skip to content

shioyang/check-pr-labels-on-push-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Check PR Labels on Push Action

This action check if given ALL labels have be applied to the PR when pushed.

Inputs

github-token

Required The repository token, i.e. secrets.GITHUB_TOKEN

labels

Required The array of label name, e.g. '["label-1", "label-2"]'

Outputs

result

The result if given ALL labels have be applied to the PR

Example Usage

uses: shioyang/[email protected]
with:
  github-token: ${{ secrets.GITHUB_TOKEN }}
  labels: '["label-1", "label-2"]'

Example Workflow

e.g. .github/workflows/main.yml

on:
  push:
    branches:
      - master

jobs:
  check_pr_labels_job:
    runs-on: ubuntu-latest
    name: A job to check the PR labels contain given labels
    steps:
    - name: Check PR labels action step
      id: check_pr_labels
      uses: shioyang/[email protected]
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}
        labels: '["enhancement"]'
      timeout-minutes: 5
    - name: See result
      run: echo "${{ steps.check_pr_labels.outputs.result }}"