From b7ebd115c0f93351b64c44b25c428d8d26530ef3 Mon Sep 17 00:00:00 2001 From: Nick Beaulieu Date: Tue, 8 Nov 2022 12:30:10 -0500 Subject: [PATCH] Adds note to README for use with private repos --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 2a35f13..08ff54f 100644 --- a/README.md +++ b/README.md @@ -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