Skip to content

Commit

Permalink
Update README to v5
Browse files Browse the repository at this point in the history
  • Loading branch information
mheap committed Jun 8, 2023
1 parent 418d9eb commit 1b8424d
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
issues: write
pull-requests: write
steps:
- uses: mheap/github-action-required-labels@v4
- uses: mheap/github-action-required-labels@v5
with:
mode: exactly
count: 1
Expand All @@ -46,7 +46,7 @@ jobs:
### Prevent merging if a label exists

```yaml
- uses: mheap/github-action-required-labels@v4
- uses: mheap/github-action-required-labels@v5
with:
mode: exactly
count: 0
Expand All @@ -60,7 +60,7 @@ You can choose to add a comment to the PR when the action fails. The default for
> Label error. Requires {{ errorString }} {{ count }} of: {{ provided }}. Found: {{ applied }}
```yaml
- uses: mheap/github-action-required-labels@v4
- uses: mheap/github-action-required-labels@v5
with:
mode: exactly
count: 1
Expand All @@ -75,7 +75,7 @@ If a comment already exists, it will be updated. When the action passes, the com
You can also customise the message used by providing the `message` input:

```yaml
- uses: mheap/github-action-required-labels@v4
- uses: mheap/github-action-required-labels@v5
with:
mode: exactly
count: 1
Expand All @@ -97,7 +97,7 @@ The following tokens are available for use in custom messages:
### Require multiple labels

```yaml
- uses: mheap/github-action-required-labels@v4
- uses: mheap/github-action-required-labels@v5
with:
mode: minimum
count: 2
Expand All @@ -115,7 +115,7 @@ However, note that if any of those three identifiers change, any "in flight" com
You can set `exit_type` to success then inspect `outputs.status` to see if the action passed or failed. This is useful when you want to perform additional actions if a label is not present, but not fail the entire build.

```yaml
- uses: mheap/github-action-required-labels@v4
- uses: mheap/github-action-required-labels@v5
with:
mode: minimum
count: 2
Expand All @@ -142,7 +142,7 @@ jobs:
status: ${{ steps.check-labels.outputs.status }}
steps:
- id: check-labels
uses: mheap/github-action-required-labels@v4
uses: mheap/github-action-required-labels@v5
with:
mode: exactly
count: 1
Expand Down Expand Up @@ -172,7 +172,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- id: check-labels
uses: mheap/github-action-required-labels@v4
uses: mheap/github-action-required-labels@v5
with:
mode: minimum
count: 1
Expand Down

0 comments on commit 1b8424d

Please sign in to comment.