From dee9ef6b07706d8f006b5990cb8efa7b6527241f Mon Sep 17 00:00:00 2001 From: Simone Busoli Date: Fri, 14 Jun 2024 12:57:04 +0200 Subject: [PATCH] docs: include permissions As documented in https://github.com/FirebaseExtended/action-hosting-deploy/issues/108#issuecomment-1406627354 --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index c755c43..d4990a1 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,19 @@ jobs: projectId: your-Firebase-project-ID ``` +### Set permissions + +The workflow needs some permissions, which need to be enabled at the repository/organization level or explicitly in the workflow. + +Enabling them in the workflow is recommended, they can be set either at the workflow or the job level: + +```yml +permissions: + checks: write + contents: read + pull-requests: write +``` + ### Deploy to your live channel on merge Add a workflow (`.github/workflows/deploy-prod.yml`):