feat!: CCIE-3896 rename CZI_GITHUB_HELPER_* to GH_ACTIONS_HELPER_* (#333

)

.github/workflows/argus-docker-build.yaml

@@ -215,8 +215,8 @@ jobs:
           build_args: ${{ matrix.image.build_args }}
           secret_files: ${{ matrix.image.secret_files }}
           image_tag: ${{ needs.prep.outputs.image_tag }}
-          github_app_id: ${{ secrets.CZI_GITHUB_HELPER_APP_ID }}
-          github_private_key: ${{ secrets.CZI_GITHUB_HELPER_PK }}
+          github_app_id: ${{ secrets.GH_ACTIONS_HELPER_APP_ID }}
+          github_private_key: ${{ secrets.GH_ACTIONS_HELPER_PK }}
 
   update-manifests:
     name: Update ArgoCD manifests
@@ -254,5 +254,5 @@ jobs:
           envs: ${{ inputs.envs }}
           image_tag: ${{ needs.prep.outputs.image_tag }}
           argus_project_dirs: ${{ steps.determine_manifests.outputs.result }}
-          github_app_id: ${{ secrets.CZI_GITHUB_HELPER_APP_ID }}
-          github_private_key: ${{ secrets.CZI_GITHUB_HELPER_PK }}
+          github_app_id: ${{ secrets.GH_ACTIONS_HELPER_APP_ID }}
+          github_private_key: ${{ secrets.GH_ACTIONS_HELPER_PK }}

README.md

@@ -8,3 +8,14 @@ Each workflow will be released with a distinct tag following semver and conventi
 NOTE:
 
 GitHub has an undocumented limitation with reusable Actions -- they must all live under `.github/workflows/`
+
+## Installation
+
+For some actions you will need to have a helper Github
+Application configured to act on behalf of Actions.
+Please [register an app](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app)
+and set these organization level
+[Github action secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions).
+
+* GH_ACTIONS_HELPER_APP_ID - app id of the github app you created
+* GH_ACTIONS_HELPER_PK - you need to generate a private key in the app settings and set the value of this secret to the private key