Skip to content

Commit f8f987f

Browse files
author
Tobiasz Kędzierski
committed
Update Readme
1 parent d664559 commit f8f987f

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img alt="label-when-approved-action status"
33
src="https://github.com/TobKed/label-when-approved-action/workflows/Test%20the%20build/badge.svg"></a>
44

5-
# Get Workflow Runs action
5+
# Label When Approved action
66

77

88
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
@@ -35,12 +35,12 @@ projects.
3535

3636
## Inputs
3737

38-
| Input | Required | Example | Comment |
39-
|-------------------------------|----------|-----------------------------------------------------------------|-------------------------------------------------------------------------|
40-
| `token` | yes | `${{ secrets.GITHUB_TOKEN }}` | The github token passed from `${{ secrets.GITHUB_TOKEN }}` |
41-
| `label` | no | `spproved by committers` | Label to be added/removed to the Pull Request if approved/not approved |
42-
| `require_committers_approval` | no | `true` | Is approval from user with write permission required |
43-
| `comment` | no | `This became approved, rerun tests manually or rebase and push` | Add optional comment to the PR when approved |
38+
| Input | Required | Example | Comment |
39+
|-------------------------------|----------|-------------------------------------------------------------------|-------------------------------------------------------------------------------|
40+
| `token` | yes | `${{ secrets.GITHUB_TOKEN }}` | The github token passed from `${{ secrets.GITHUB_TOKEN }}` |
41+
| `label` | no | `Approved by committers` | Label to be added/removed to the Pull Request if approved/not approved |
42+
| `require_committers_approval` | no | `true` | Is approval from user with write permission required |
43+
| `comment` | no | `PR approved by at least one committer and no changes requested.` | Add optional comment to the PR when approved (requires label input to be set) |
4444

4545
## Outputs
4646

@@ -68,14 +68,15 @@ jobs:
6868
isApprovedByAnyone: ${{ steps.label-when-approved-by-anyone.outputs.isApproved }}
6969
steps:
7070
- name: Label when approved by commiters
71-
uses: TobKed/label-when-approved-action@v0.1
71+
uses: TobKed/label-when-approved-action@v1
7272
id: label-when-approved-by-commiters
7373
with:
7474
token: ${{ secrets.GITHUB_TOKEN }}
7575
label: 'ready to merge (committers)'
7676
require_committers_approval: 'true'
77+
comment: 'PR approved by at least one committer and no changes requested.'
7778
- name: Label when approved by anyone
78-
uses: TobKed/label-when-approved-action@v0.1
79+
uses: TobKed/label-when-approved-action@v1
7980
id: label-when-approved-by-anyone
8081
with:
8182
token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)