GitHub Actions workflow
Use our guide to set up GitHub Actions build and deploy to manage releases in Aviator. Instructions on authentication, building and deploying workflows.
Last updated
Was this helpful?
Use our guide to set up GitHub Actions build and deploy to manage releases in Aviator. Instructions on authentication, building and deploying workflows.
Last updated
Was this helpful?
Use this guide to configure GitHub actions build and deploy steps to manage releases in Aviator. To use Aviator Releases, we recommend have separate steps for the . You may still use it as a single step, in which case the creation of Release (the build part) will be a no-op.
Generate an Aviator API token at
Set up environment variables and secrets for your GitHub repo at Settings > Secrets and Variables > Actions
Add a repository secret AVIATOR_API_TOKEN
as the API token generated above
When getting started with Aviator Releases, we recommend duplicating your existing workflow files in GitHub.
NOTE: The new workflows need to be merged to your default branch in order to take effect
Aviator triggers GitHub using . This workflow requires specifying the following params in your workflow file:
Add a workflow job at the beginning of the build workflow to sync the workflow run ID with Aviator. This helps Aviator track the CI action that’s running your build.
After this you can keep your regular builds steps as is. Make sure to tag the build artifacts with the release version using ${{inputs.aviator_release_candidate_version}}
so that you can refer to them in the deployment step.
If you want to skip the Build step entirely, select “Not Configured” in the Build step:
In this configuration mode, as soon as a Release is cut, the build is marked as completed. Then you can set up deployment as a separate step.
Similar to the Build step, duplicate the Deploy step as well and apply the following parameters in your workflow file. Note that these are different than the build params:
Add a workflow job at the beginning of the deploy workflow to sync the workflow run ID with Aviator. Note that the API URL is different from the build workflow.
After this you can keep your regular deploys steps as is. Make sure to use the same build artifacts with the release version using ${{inputs.aviator_release_candidate_version}}
so that you can refer to them in the deployment step.
Now you should be ready to use Aviator Release Management!