https://github.com/sugarshin/required-labels-action

A GitHub Actions that automated label checking for pull requests
https://github.com/sugarshin/required-labels-action

Last synced: 3 months ago
JSON representation

A GitHub Actions that automated label checking for pull requests

• Host: GitHub
• URL: https://github.com/sugarshin/required-labels-action
• Owner: sugarshin
• Created: 2020-02-20T11:00:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-08-18T19:22:23.000Z (about 2 years ago)
• Last Synced: 2024-07-11T04:35:42.834Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 263 KB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 23
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# required-labels-action

![GitHub release (latest by date)](https://img.shields.io/github/v/release/sugarshin/required-labels-action?include_prereleases)

A GitHub Actions that automated label checking for pull requests.

## Usage

### Inputs

|Parameter|Required|Description|

|:--:|:--:|:--|

|required_any|false|At least one of these comma separated labels should be present on all Pull requests|

|required_all|false|All of these comma separated labels must be present on all Pull requests|

|required_oneof|false|At only one of these comma separated labels should be present on all Pull requests|

|banned|false|None of these comma separated labels can be present on all Pull requests|

### Outputs

|Parameter|Value|

|:--:|:--|

|required_labels|ok|

## Example Workflow

```yaml

name: Check labels

on:

  pull_request:

    types: [opened, labeled, unlabeled, reopened]

jobs:

  check-label:

    runs-on: ubuntu-18.04

    steps:

      - uses: sugarshin/[email protected]

        with:

          required_all: 'approved'

          required_oneof: 'patch,minor,major'

```