changing an env var name to have better consistancy (#73)

* changing an env var name to have better consistancy * Sentence change --------- Co-authored-by: Pierre Pernot <[email protected]@192165103.ip.ecodatacenter.tech> Co-authored-by: Pierre Pernot <[email protected]@Pierres-MacBook-Pro.local>
cognitedata · Dec 11, 2023 · fed1894 · fed1894
1 parent a161957
commit fed1894
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/.github/workflows/deploy-functions.yaml b/.github/workflows/deploy-functions.yaml
@@ -95,7 +95,7 @@ jobs:
 
           # Parameters we get from Github secret storage:
           deployment_client_secret: ${{secrets.DEPLOYMENT_CLIENT_SECRET }}
-          schedules_client_secret: ${{ secrets.SCHEDULE_CLIENT_SECRET }}
+          schedules_client_secret: ${{ secrets.SCHEDULES_CLIENT_SECRET }}
           function_secrets: ${{ secrets[steps.extract_secrets.outputs.extra_secrets_name] }}
 
           # Individual parameters per function we read from:

diff --git a/README.md b/README.md
@@ -246,7 +246,7 @@ Each workflow consists of a series of sequentially executed steps. As an input t
 **All client secrets *must* be stored as GitHub secrets.**
 All secrets should be organized in github environments, and the following should be defined:
 * `DEPLOYMENT_CLIENT_SECRET` should contain the client secret for the service account used at runtime when running on a schedule.
-* `SCHEDULE_CLIENT_SECRET` should contain the client secret for the service account used at runtime when running on a schedule.
+* `SCHEDULES_CLIENT_SECRET` should contain the client secret for the service account used at runtime when running on a schedule.
 * **Super-pro-tip:** By having multiple environments you can support more than one target CDF project!
 
 Adding extra secrets to specific functions:
@@ -282,7 +282,7 @@ The function configuration files for my_cognite_function would be:
 * `my_cognite_function/function_config_???.yaml` This is a configuration file that is applicable for the function for the ??? environments. Typically at least `data_set_id` would reside here.
 
 If same key is found in different configuration files, the last read will be applied. The GitHub action reads these configurations in the order specified here.
-Access configuration is stored as secrets in GitHub under `DEPLOYMENT_CLIENT_ID`, `DEPLOYMENT_CLIENT_SECRET`, `SCHEDULE_CLIENT_ID` and `SCHEDULE_CLIENT_SECRET`.
+Client secrets are stored as secrets in GitHub under `DEPLOYMENT_CLIENT_SECRET` and `SCHEDULES_CLIENT_SECRET`.
 
 ## Continuous Deployment