@@ -204,3 +204,42 @@ mvn play2:run
204204``` shell
205205curl http://localhost:9000/health
206206```
207+
208+ ### GitHub Actions Workflow Prerequisites
209+
210+ To ensure the GitHub Actions workflows in this repository function correctly, the following prerequisites must be met:
211+
212+ 1 . ** Secrets Configuration** :
213+ - Ensure the following secrets are configured in your GitHub repository:
214+
215+ #### GCP (Google Cloud Platform)
216+ - ` GCP_SERVICE_ACCOUNT_KEY ` : Base64-encoded service account key for GCP.
217+ - ` REGISTRY_NAME ` : GCP registry name (e.g., ` asia-south1-docker.pkg.dev ` ).
218+ - ` REGISTRY_URL ` : URL of the GCP container registry (e.g., ` asia-south1-docker.pkg.dev/sunbird-morocco-sandbox-434709/sunbird-morocco-artifact-dev ` ).
219+
220+ #### DockerHub
221+ - ` REGISTRY_USERNAME ` : DockerHub username.
222+ - ` REGISTRY_PASSWORD ` : DockerHub password.
223+ - ` REGISTRY_NAME ` : DockerHub registry name (e.g., ` docker.io ` ).
224+ - ` REGISTRY_URL ` : URL of the DockerHub registry. (e.g., ` docker.io/<username> ` )
225+
226+ #### Azure Container Registry (ACR)
227+ - ` REGISTRY_USERNAME ` : ACR username (service principal or admin username).
228+ - ` REGISTRY_PASSWORD ` : ACR password (service principal secret or admin password).
229+ - ` REGISTRY_NAME ` : ACR registry name (e.g., ` myregistry.azurecr.io ` ).
230+ - ` REGISTRY_URL ` : URL of the ACR registry (e.g., ` myregistry.azurecr.io ` ).
231+
232+ #### GitHub Container Registry (GHCR)
233+ - ` GITHUB_TOKEN ` : GitHub token for authentication.
234+ - ` REGISTRY_NAME ` : GitHub Container Registry name (e.g., ` ghcr.io ` ).
235+ - ` REGISTRY_URL ` : URL of the GHCR registry (e.g., ` ghcr.io/<organization>/<repository> ` ).
236+
237+ Ensure these secrets are added to the repository settings under ** Settings > Secrets and variables > Actions** .
238+
239+ 2 . ** Environment Variables** :
240+ - The following environment variables must be set in the repository or workflow:
241+ - ` CLOUD_STORE_GROUP_ID ` : The group ID for cloud storage dependencies.
242+ - ` CLOUD_STORE_ARTIFACT_ID ` : The artifact ID for cloud storage dependencies.
243+ - ` CLOUD_STORE_VERSION ` : The version of the cloud storage dependencies.
244+
245+ By ensuring these prerequisites are met, the workflows in this repository will execute successfully.
0 commit comments