Skip to content

A GitHub Action that checks if the pull request target branch matches with its labels.

License

Notifications You must be signed in to change notification settings

Logerfo/target-label-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

Dependencies Status

Target Label Action

This action will check if the pull request target branch matches with its labels.

Setting up

Create a file named .github/workflows/target-label.yml.

Minimal Configuration

name: Target Label
on: 
  pull_request:
    types: [labeled, unlabeled]
    
jobs:
  build:
    name: Target Label
    runs-on: ubuntu-16.04
    steps:
    - uses: actions/checkout@master
    - uses: Logerfo/target-label-action@0.0.1
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }}

Complete configuration

All values are default.

name: Target Label
on: 
  pull_request:
    types: [labeled, unlabeled]
    
jobs:
  build:
    name: Target Label
    runs-on: ubuntu-16.04
    steps:
    - uses: actions/checkout@master
    - uses: Logerfo/target-label-action@0.0.1
      with:
        github-token: ${{ secrets.GITHUB_TOKEN }} # The `GITHUB_TOKEN` secret.
        config-path: .github/target-label.yml # The path of the addtional configurations file.
        apply: never # `never` to never apply labels;
                     # `first` to always apply the first label;
                     # `single` to only apply when the number of labels is one.

Additional configurations file

You also need create a additional configuration file. The default path is .github/target-label.yml, but you can change it in the action configuration file, as shown above.
The file must follow the following structure:

target-branch: [labels]

For example:

master: [bug, enhancement]
dev: [feature]

Auto update

You can use (at your own risk) the release branch instead of the specific version tag.
Never user master, since the distribution file does not exist in this branch and the action will always fail.

Changelog

Click here.

Contributing

If you have suggestions for how close-label could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

Donate

BTC: 1LoGErFoNzE1gCA5fzk6A82nV6iJdKssSZ