Add comment justifying contents: write

AJGranowski · Sep 29, 2024 · 55e3a5a · 55e3a5a
1 parent a8a040e
commit 55e3a5a
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml
@@ -194,7 +194,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: ci
     permissions:
-      contents: write
+      contents: write # Needed to create a release https://docs.github.com/en/rest/releases/releases#create-a-release
 
     if: ${{ startsWith(github.ref, 'refs/tags/release-') }}
     steps:
@@ -225,4 +225,4 @@ jobs:
           artifactErrorsFailBuild: true
           artifacts: "release/entrypoint,release/user-mirror"
           generateReleaseNotes: true
-          name: Release ${{ env.RELEASE_VERSION }}
+          name: Release ${{ env.RELEASE_VERSION }}