After reading the documentation of the Events that trigger workflows, I wonder if it's possible to run a workflow with a given label name, like RFR or WIP.
I know we can run a workflow when the pull request is labeled, but there is nothing more for a specifc label name :
on:
pull_request:
types: [labeled]
Has anyone done this before ?
You can achieve running a workflow on labeling a Pull Request using a conditional expression like
if: ${{ github.event.label.name == 'label_name' }}
So if you have your GitHub action config as below
name: CI
on:
pull_request:
types: [ labeled ]
jobs:
build:
if: ${{ github.event.label.name == 'bug' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run a one-line script
run: echo Hello, world!
It would trigger the workflow whenever a PR is labeled and run the job only if the label is bug and would skip if the label is anything else. You can also use github.event.action == 'labeled' as an extra check but that is not required if you have only types: [ labeled ] for the pull_request as shown in the config above.
Note: Just for your information, the github event has the following info (removed the irrelevant data for brevity) regarding the label in case of labelling a PR
"event": {
"action": "labeled",
"label": {
"color": "d73a4a",
"default": true,
"description": "Something isn't working",
"id": 1519136641,
"name": "bug",
"node_id": "abcd",
"url": "https://api.github.com/repos/owner/repo/labels/bug"
}
}
GitHub actions documentation regarding conditional expressions is here.
bug and security. Does this approach will work?
github.event.pull_request.labels field. Here's a simplified example: if: contains(github.event.pull_request.labels.*.name, '<label_name>'). You will also need to make sure you specify "labeled", "opened", "synchronize" and "reopened" in pull_request.types
Per this comment, the condition to check is:
if: contains(github.event.pull_request.labels.*.name, '<label_name>')
pull_request workflow, it doesn't pick up the labels added after the PR was raised. In that case, one needs to close and re-open the PR or just create a new PR.
PR labeled trigger in your workflow then it wouldn't work. You need this: on: pull_request: types: [ labeled ] @vishwarajanand
I didn't need to have the labeled type to make it work, just as this answer I've manage to have it working with this condition:
name: ExampleWorkflow
on:
pull_request:
branches:
- main
jobs:
ExampleJob:
if: contains(github.event.pull_request.labels.*.name, 'example-label')
This way, the workflow ExampleWorkflow will be triggered for any pull request with target branch main and the job ExampleJob will be skipped if the PR doesn't have the label example-label
