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 build and deploy workflows . You may still use it as a single step, in which case the creation of Release (the build part) will be a no-op. Authentication Generate an Aviator API token at https://app.aviator.co/settings/workspace/integrations 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 Build workflow Option A - Using Two-step workflow 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 workflow dispatch REST API . This workflow requires specifying the following params in your workflow file: Copy

on:
  workflow_dispatch:
    inputs:
      aviator_release_cut_id:
        description: "Database ID of release cut"
        required: false
        type: string
      aviator_release_cut_commit_hash:
        description: "Commit SHA, branch name, or tag of the HEAD to be built"
        required: false
        type: string
      aviator_release_candidate_version:
        description: "Name of the version"
        required: true
        type: string

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. Option B - Skipping build step If you want to skip the Build step entirely, select “Not Configured” in the Build step: Skip 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. Deploy workflow 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! Previous Working with your CI / CD Next Buildkite workflow Last updated 1 year ago Was this helpful?