Update docs/example to include id-token: write permission

probcomp · May 29, 2024 · 784eaa0 · 784eaa0
1 parent cee8070
commit 784eaa0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/.github/workflows/publish_private_website_example.yml b/.github/workflows/publish_private_website_example.yml
@@ -5,6 +5,9 @@ on:
     branches:
       - main
 
+permissions:
+  id-token: write 
+
 jobs:
   prepare:
     runs-on: ubuntu-latest
@@ -26,3 +29,4 @@ jobs:
       artifact: website
 
 
+
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ This repo contains code and workflows that enable probcomp repositories to publi
 
 ### I manage a probcomp repo. How do I use this?
 
-Create a GitHub action which builds your repo's website, and then follow the example in `.github/workflows/publish_private_website_example.yml`. You'll need to create an artifact containing your website files (at the end of your job where you build the site), and then pass that artifact's name to the action `probcomp/gen-website-private/.github/workflows/publish_private_website.yml@main`.
+Create a GitHub action which builds your repo's website, and then follow the example in `.github/workflows/publish_private_website_example.yml`. You'll need to create an artifact containing your website files (at the end of your job where you build the site), and then pass that artifact's name to the action `probcomp/gen-website-private/.github/workflows/publish_private_website.yml@main`. The action requires `id-token: write` permissions.
 
 Your repo will be served from its own subdomain: `<REPO>.gen.dev`.