From f8f987f95729754f98fa3b7167130247095cfc0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobiasz=20K=C4=99dzierski?= Date: Tue, 27 Oct 2020 10:44:31 +0100 Subject: [PATCH] Update Readme --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2bfadcb..311f2f9 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ label-when-approved-action status -# Get Workflow Runs action +# Label When Approved action @@ -35,12 +35,12 @@ projects. ## Inputs -| Input | Required | Example | Comment | -|-------------------------------|----------|-----------------------------------------------------------------|-------------------------------------------------------------------------| -| `token` | yes | `${{ secrets.GITHUB_TOKEN }}` | The github token passed from `${{ secrets.GITHUB_TOKEN }}` | -| `label` | no | `spproved by committers` | Label to be added/removed to the Pull Request if approved/not approved | -| `require_committers_approval` | no | `true` | Is approval from user with write permission required | -| `comment` | no | `This became approved, rerun tests manually or rebase and push` | Add optional comment to the PR when approved | +| Input | Required | Example | Comment | +|-------------------------------|----------|-------------------------------------------------------------------|-------------------------------------------------------------------------------| +| `token` | yes | `${{ secrets.GITHUB_TOKEN }}` | The github token passed from `${{ secrets.GITHUB_TOKEN }}` | +| `label` | no | `Approved by committers` | Label to be added/removed to the Pull Request if approved/not approved | +| `require_committers_approval` | no | `true` | Is approval from user with write permission required | +| `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) | ## Outputs @@ -68,14 +68,15 @@ jobs: isApprovedByAnyone: ${{ steps.label-when-approved-by-anyone.outputs.isApproved }} steps: - name: Label when approved by commiters - uses: TobKed/label-when-approved-action@v0.1 + uses: TobKed/label-when-approved-action@v1 id: label-when-approved-by-commiters with: token: ${{ secrets.GITHUB_TOKEN }} label: 'ready to merge (committers)' require_committers_approval: 'true' + comment: 'PR approved by at least one committer and no changes requested.' - name: Label when approved by anyone - uses: TobKed/label-when-approved-action@v0.1 + uses: TobKed/label-when-approved-action@v1 id: label-when-approved-by-anyone with: token: ${{ secrets.GITHUB_TOKEN }}