Skip to content

Usage (If you have filled the website form)

Álvaro García Pizarro edited this page Sep 11, 2024 · 5 revisions

Usage Guide

Congratulations! You’re all set up and ready to go with GAWG. This guide will walk you through the key files you need to be aware of and provide instructions for configuring SonarCloud analysis if you’ve opted to use it.

Important Files

1. Workflow File

The workflow file is located inside .github/workflows in your repository. This file is automatically configured and ready to use. You do not need to make any modifications to this file. It handles the CI/CD pipeline based on your selected settings.

2. sonar-project.properties Configuration

If you have enabled SonarCloud analysis, you need to configure the sonar-project.properties file. This file is crucial for SonarCloud to analyze your codebase effectively. To configure this file check: How to configure sonar-project.properties

3. workflow_config.yml

The workflow_config.yml file is used to configure various aspects of the build and deployment process. To configure this file check: [How to configure the workflow_config.yml file] (https://github.com/alvarogarciapiz/gawg/wiki/Configure-workflow_config.yml-file).

If you need further assistance, please refer to the GAWG documentation or contact support.