Skip to content

Workflow Permissions

Josh Soref edited this page Feb 25, 2024 · 3 revisions

Workflow Permissions

contents: read

Generally speaking, check-spelling needs to be able to check out the repository with the source code.

The normal way to do that is with:

Permissions

permissions:
  contents: read

Steps

- uses: actions/checkout@...

or

- uses: check-spelling/check-spelling@...
  with:
    checkout: 1

pull-requests: read

In order to stop early when configured with suppress_push_for_open_pull_request, check-spelling needs to be able to check for pull requests.

Permissions

permissions:
  pull-requests: read

actions: read

In order to retrieve artifacts with post_comment, check-spelling will need actions: read.

The normal way to do that is with:

Permissions

permissions:
  actions: read
Clone this wiki locally