https://github.com/joerick/pr-labels-action
A Github action that extracts labels from the PR that this build belongs to, and makes them available to other actions.
https://github.com/joerick/pr-labels-action
Last synced: 10 months ago
JSON representation
A Github action that extracts labels from the PR that this build belongs to, and makes them available to other actions.
- Host: GitHub
- URL: https://github.com/joerick/pr-labels-action
- Owner: joerick
- Created: 2020-11-20T15:24:24.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T20:50:07.000Z (over 1 year ago)
- Last Synced: 2025-03-18T07:32:16.694Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 458 KB
- Stars: 29
- Watchers: 3
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PR Labels Github Action
A Github action that extracts labels from the PR that this build belongs to, and makes them available to other actions. Labels are available as step outputs and environment variables that you can use in later steps in your action.
## Outputs
### `labels`
The labels on this PR. A string containing tag identifiers surrounded with spaces for easy use with `contains`.
### `labels-object`
The labels on this PR. A dictionary containing `true` where a label exists.
## Example usage
```yaml
jobs:
test:
steps:
- name: Get PR labels
id: pr-labels
uses: joerick/pr-labels-action@v1.0.8
```
## How do I use this?
Perhaps you have a test that you only want to run when PR label `Test Flimbomble` is set. Your workflow should look like this:
```yaml
jobs:
test:
steps:
- name: Get PR labels
id: pr-labels
uses: joerick/pr-labels-action@v1.0.8
# GITHUB_PR_LABEL_TEST_FLIMBOMBLE was set by pr-labels-action
- run: |
bin/run_normal_tests
if [ -n "$GITHUB_PR_LABEL_TEST_FLIMBOMBLE" ]; then
bin/run_flimbomble_tests
fi
# or you can use the action output.
# For the label name, use lowercase kebab-case and surround with spaces
- run: |
bin/publish_flimbomble_test_results
if: contains(steps.pr-labels.outputs.labels, ' test-flimbomble ')
```