Secrets configuration

This workflow relies on a series of GitHub Secrets that you need to configure to make this workflow work correctly. This secrets will only be available in your repository and GAWG won't see them.

Note

Add the secret names as shown. Any misspelling will cause the workflow to fail. If the secret is missing the workflow will alert you and show you how to add it.

How to add a GitHub Secret?

You can always check the official GitHub documentation but here you'll find a shorter and simplified version. The process of adding a GitHub repository secret is:

1. Go to your repository settings.
2. Under the Security tab click on Secrets and Variables and select Actions from the dropdown.
3. In the Name field, type a name for your secret.
4. In the Name field, type a name for your secret.
5. In the Secret field, enter the value for your secret.
6. Click Add secret.

What secrets do I need to add?

Not all secrets are required to make the workflow run. You may also found that you don't need any. Just check this list:

• SONAR_TOKEN: Add this secret if you have SonarCloud Analysis enabled in your workflow_config.yml file.
• SLACK_CHANNEL: Add this secret if you have notifications enabled and set to slack. To obtain a channel ID, right-click on the channel name and select 'Copy link'. The channel ID is the last part of the URL.
• SLACK_TOKEN: Add this secret if you have notifications enabled and set to slack. To obtain a token, create a new Slack app, install it in a channel, and get the Bot user OAuth Token from the Install App section.
• DISCORD_WEBHOOK_URL: Add this secret if you have notifications enabled and set to discord. To obtain a webhook URL, go to your Discord server settings, select 'Integrations', and create a new webhook.
• AWS_ACCESS_KEY_ID: Add this secret if you have any aws deployment enabled.
• AWS_SECRET_ACCESS_KEY: Add this secret if you have any aws deployment enabled.
• DOCKER_USERNAME: Add this secret if you are deploying content to DockerHub.
• DOCKER_PASSWORD: Add this secret if you are deploying content to DockerHub.