docs(actions/helm/release-chart): add required permissions

Signed-off-by: Emilien Escalle <[email protected]>
hoverkraft-tech · Apr 10, 2024 · 8b8d050 · 8b8d050
1 parent ffaa65f
commit 8b8d050
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/actions/helm/release-chart/README.md b/actions/helm/release-chart/README.md
@@ -20,6 +20,9 @@ Action to release a Helm chart to OCI registry
 <!-- end description -->
 <!-- start contents -->
 <!-- end contents -->
+
+## Usage
+
 <!-- start usage -->
 
 ```yaml
@@ -75,6 +78,16 @@ Action to release a Helm chart to OCI registry
 ```
 
 <!-- end usage -->
+
+## Permissions
+
+This action requires the following permissions on the repository:
+
+- `contents: read`: to read the chart files
+- `packages: write`: to publish the chart to the OCI registry (required for Github Package registry only)
+
+## Inputs
+
 <!-- start inputs -->
 
 | **Input**                          | **Description**                                                                                                                                                                                                                                         | **Default**                                 | **Required** |