From ded142ef1baa10fac19129f72d11b8b3a944b1c3 Mon Sep 17 00:00:00 2001 From: ICHINOSE Shogo Date: Tue, 26 Dec 2023 11:38:48 +0900 Subject: [PATCH] add documents for the permissions --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 3007ab3..3ef8656 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,20 @@ inputs: default: 'true' ``` +## Required Permissions + +The action requires the following permissions: + +```yaml +permissions: + contents: read + checks: write + issues: write + pull-requests: write +``` + +See [Assigning permissions to jobs](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) for more details. + ## Usage Example ```yaml