Checks or unchecks a checkbox in the body of the pull request. This library runs with GitHub Actions. If you feel that the example grammar below is not friendly enough, we recommend reading this page first.

I think the most common use is to visualize the results of CI execution, and here's an example.

  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'

Optional However, one of the list and matches required. Line separated List of checkboxes to modify.

Optional However, one of the list and matches required. Regular expression for the checkbox to modify.

Optional check, uncheck. This default to 'check'

Optional error, warn or ignore. Specifies whether to skip or raise an error when not found. This defaults to error

Optional The GitHub access token (e.g. secrets.GITHUB_TOKEN) used to update the body. This defaults to {{ github.token }}.

No output