Skip to content

installation guide

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

Installation Guide for GAWG

To get started with GAWG, follow these steps to set up and configure your GitHub Actions workflows.

Step-by-Step Installation Process

  1. Visit the GAWG Get Started Page

    Go to GAWG Website.

  2. Fill Out the Form

    Complete the form with the necessary information:

    • Repository Full Name: Enter your GitHub username followed by the repository name in the format username/repo-name. For example, alvarogarciapiz/gawg.
    • Project Technology: Specify the technology used in your project (e.g., Java, Node, Python). Note that additional technologies are in development and will be available soon.
    • Docker: If you are using Docker, tick the checkbox.
    • Notify Method: Select your preferred notification method from the dropdown menu. Options include Slack, Microsoft Teams, Discord, Email, and more to come.
    • Email Address: Enter your email address.
    • Deploy Type: Choose the deploy type from the dropdown menu (e.g., EKS, DockerHub, S3). Note that additional deploy types will be available in the future.
    • Self-Hosted Runners: If you are using self-hosted runners, tick the checkbox and specify the tags to use, separated by commas with no spaces.
    • Push Branches Trigger: Enter the branches separated by commas. If any push is made to those branches the workflow will trigger.
    • Schedule Cron Trigger: Specify the cron schedule if applicable. Check Cron guru for examples.
    • Pull Request Branches Trigger: Enter the branches to be used for pull requests, separated by commas. If any pull request is made to that branch the workflow will trigger.
  3. Install the GitHub App

    After filling out the form, you will be automatically redirected to install the GAWG GitHub App.

    Important: Install the app only in the specified repository. Installing it in other repositories will prevent GAWG from automatically filling your workflow configuration.

  4. Complete the Setup

    Wait a few seconds for the installation and configuration to finalize.

  5. Further Configuration

    For any additional configuration needs, please refer to the Usage page if you filled the website form and installed the app section or the Usage page if you only installed the app


Follow these steps to ensure a smooth setup and proper configuration of your GAWG workflows. If you encounter any issues, check the further configuration section or contact support for assistance.