Skip to content

Commit

Permalink
Merge pull request #195 from nickbeaulieu/update-readme-private-repos
Browse files Browse the repository at this point in the history
Adds note to README for use with private repos
  • Loading branch information
phips28 authored Nov 8, 2022
2 parents a0355e0 + b7ebd11 commit 14842c1
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@ you'll need to configured that workflow yourself. You can look to the

Make sure you use the `actions/checkout@v2` (or later) action!

**Private repos**

To use this Action with `${{ secrets.GITHUB_TOKEN }}` in a private repo, you must set the `contents: write` [permission for the token](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) to write to the package.json file specified in the workflow.

```yml
# .github/workflows/[your_workflow].yml

jobs:
publish:
...
permissions:
contents: write
```
**Migration: Version v9 and up**
Remove the 'actions/setup-node@v1' step from your action.yml file
Expand Down

0 comments on commit 14842c1

Please sign in to comment.