From 0e4bfbb4df4f1844bd821510dd84c6afbc7fae71 Mon Sep 17 00:00:00 2001 From: marocchino Date: Sun, 26 Mar 2023 07:23:21 +0900 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e9c56ce..51725aa 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,30 @@ This library runs with GitHub Actions. If you feel that the example grammar belo ## Usage -TBD +I think the most common use is to visualize the results of CI execution, and here's an example. + +```yaml + test: # make sure the action works on a clean machine without building + runs-on: ubuntu-latest + permissions: + pull-requests: write + steps: + - uses: actions/checkout@v3 + - uses: marocchino/checkbox-action@v1 + with: + list: 'test ok' + action: 'uncheck' + error: 'warn' + - run: | + yarn + - run: | + yarn all + - uses: marocchino/checkbox-action@v1 + with: + list: 'test ok' + action: 'check' + error: 'warn' +``` ## Inputs @@ -29,7 +52,7 @@ Regular expression for the checkbox to modify. ### `error` -**Optional** error, warn or ignore. Specifies whether to skip or raise an error when error occurred. This defaults to error +**Optional** error, warn or ignore. Specifies whether to skip or raise an error when not found. This defaults to error ### `GITHUB_TOKEN`