Skip to main content

Updating Your Pipeline

Keeping Gruntwork Pipelines updated is straightforward. Regular updates are released to ensure optimal performance and scalability for managing infrastructure changes.

Regular updates are released for the Pipelines CLI, associated GitHub Actions Workflows, and custom GitHub Actions. To apply the latest updates across these components, modify the pipelines.yml file located in the .github/workflows directory of any repository integrated with Gruntwork Pipelines. Update the file to reference the latest version of the Pipelines GitHub Actions Workflow:

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

Due to our integration with Dependabot, you can automatically receive pull requests suggesting updates to the pipelines.yml file in your repository by including a .github/dependabot.yml file. This ensures your repository stays aligned with the latest changes in Gruntwork Pipelines. Gruntwork AWS Accelerator customers receive this configuration as part of their infrastructure-live repositories by default.

note

Gruntwork recommends leaving your workflow reference at a major-tag shorthand, such as v3 to automatically get the latest minor-tag updates.

Pipelines release notifications​

To stay informed about new releases of Gruntwork Pipelines, you have two main options:

  • GitHub notifications: Open the pipelines-workflows repository, click Watch, choose Custom, and enable Releases. GitHub will email you when a new release is published. This is the lowest-friction option and does not require a feed reader.

  • RSS feed: Subscribe to the Atom feed for the repository:

    https://github.com/gruntwork-io/pipelines-workflows/releases.atom

    This feed can be consumed by:

    • A standalone RSS reader such as Feedly, NetNewsWire, or Inoreader.
    • Slack or Microsoft Teams, which can both post RSS items to a channel (Slack via its /feed slash command, Teams via an RSS connector). This lets release announcements land directly in a shared channel.
note

If you've configured Dependabot for your repository, it will also surface new releases by opening pull requests.

Updating customized workflows​

If you have customized workflows as outlined in Extending Pipelines, maintaining updates to these workflows may require additional effort. For those who have forked the pipelines-workflows repository to implement customizations, manual updates will be necessary to incorporate the latest changes from the upstream repository.

To update your workflows, follow the instructions provided in the GitHub documentation. This process applies as long as there are no conflicts between your customizations and the upstream repository.