Skip to content

Commit

Permalink
chore: add permissions configuration in the README.md (#96)
Browse files Browse the repository at this point in the history
* Mention permissions configuration in the README.md

* Apply suggestions from code review

Co-authored-by: Steven <steven@ceriously.com>

Co-authored-by: Steven <steven@ceriously.com>
  • Loading branch information
adrienbernede and styfle committed Jun 4, 2021
1 parent 1f10757 commit 531a036
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Expand Up @@ -29,7 +29,6 @@ jobs:
# ... etc
```


### Advanced: Canceling Other Workflows

In some cases, you may wish to avoid modifying all your workflows and instead create a new workflow that cancels your other workflows. This can be useful when you have a problem with workflows getting queued.
Expand Down Expand Up @@ -121,6 +120,29 @@ jobs:
access_token: ${{ github.token }}
```

### Advanced: Token Permissions

No change to permissions is required by default. The instructions below are for improved control over of those permissions.

By default, GitHub creates the `GITHUB_TOKEN` for Actions with some read/write permissions. It may be a good practice to switch to read-only permissions by default. Visit the [dedicated documentation page](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/disabling-or-limiting-github-actions-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository) for details.

Permissions can be set for all Jobs in a Workflow or a specific Job, see the [reference manual page](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions). `cancel-workflow-action` only requires write access to the `actions` scope, so it is enough to have:

```yml
jobs:
test:
runs-on: ubuntu-latest
permissions:
actions: write
steps:
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.9.0
with:
access_token: ${{ github.token }}
```

_Note_ : This is typical when global access is set to be restrictive. Only this job will elevate those permissions.

## Contributing

- Clone this repo
Expand Down

0 comments on commit 531a036

Please sign in to comment.