Skip to main content

GitHub Workflows

Pipelines integrates with your repositories through GitHub Workflows, leveraging Reusable Workflows from Gruntwork's pipelines-workflows repository. The workflows in your repositories rely on Gruntwork workflows through the uses clause within a job. This is structured as follows:

jobs:
  GruntworkPipelines:
    uses: gruntwork-io/pipelines-workflows/.github/workflows/pipelines-root.yml@v3

Workflow versioning​

Gruntwork follows Semantic Versioning for pipelines-workflows releases. New releases are tracked using git tags in the v.MAJOR.MINOR.PATCH format. A major tag, such as v.MAJOR, is also maintained and updated to point to the latest release within that major version. For example, when releasing a patch update from v3.0.1 to v3.0.2, the v3 tag will be updated to reference the newer version.

When referencing a workflow, the version is specified in the uses clause. For example: pipelines-root.yml@v3. Using the major version, like v3, in your workflows ensures you receive the latest updates and performance enhancements.. However, you can choose to pin to a specific version if needed.

Modifying workflows​

Changes made to workflows in your repositories only affect the specific repository where the modification occurs. For instance, customizing the pipelines.yml workflow in your infrastructure-live-root repository will not impact workflows in other repositories, such as delegated repositories.

If you fork the Gruntwork Workflows, you can make changes that affect multiple repositories. Be sure to understand the dependencies between workflows in the pipelines-workflows repository and your repositories. The dependencies are detailed below.

Workflow dependencies​

The pipelines-workflows repository includes the following reusable workflows:

  • pipelines-drift-detection.yml - Used for Pipelines Drift Detection in all repositories with Drift Detection installed.
  • pipelines-root.yml - The core Pipelines workflow for the infrastructure-live-root repository, providing core plan/apply functionality and account vending.
  • pipelines-unlock.yml - Used to manually unlock state files in all repositories.
  • pipelines.yml - The core Pipelines workflow for infrastructure-live-access-control and delegated repositories, supporting plan/apply operations.

In your repositories, the following workflows are typically present:

infrastructure-live-root​

  • account-factory.yml - A standalone workflow independent of pipelines-workflows.
  • pipelines-drift-detection.yml (Enterprise only) - Uses the Gruntwork pipelines-drift-detection.yml workflow.
  • pipelines-unlock.yml - Uses the Gruntwork pipelines-unlock.yml workflow.
  • pipelines.yml - Uses pipelines-root.yml.

infrastructure-live-access-control​

  • pipelines-drift-detection.yml (Enterprise only) - Uses the Gruntwork pipelines-drift-detection.yml workflow.
  • pipelines-unlock.yml - Uses the Gruntwork pipelines-unlock.yml workflow.
  • pipelines.yml - Uses pipelines.yml.

infrastructure-live-delegated (Vended Delegated Repositories)​

  • pipelines-drift-detection.yml - Uses the Gruntwork pipelines-drift-detection.yml workflow.
  • pipelines-unlock.yml - Uses the Gruntwork pipelines-unlock.yml workflow.
  • pipelines.yml - Uses pipelines.yml.