https://github.com/envato/aws-cloudfront-invalidation-buildkite-plugin

A Buildkite plugin that invalidates AWS Cloudfront caches.
https://github.com/envato/aws-cloudfront-invalidation-buildkite-plugin

aws-cloudfront buildkite-plugin

Last synced: about 1 month ago
JSON representation

A Buildkite plugin that invalidates AWS Cloudfront caches.

• Host: GitHub
• URL: https://github.com/envato/aws-cloudfront-invalidation-buildkite-plugin
• Owner: envato
• License: mit
• Created: 2019-11-06T05:20:13.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-08-28T02:21:51.000Z (about 1 year ago)
• Last Synced: 2025-05-14T11:19:08.823Z (5 months ago)
• Topics: aws-cloudfront, buildkite-plugin
• Language: Shell
• Homepage:
• Size: 15.6 KB
• Stars: 0
• Watchers: 60
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# AWS Cloudfront Invalidation Buildkite Plugin

[![tests](https://github.com/envato/aws-cloudfront-invalidation-buildkite-plugin/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/envato/aws-cloudfront-invalidation-buildkite-plugin/actions/workflows/tests.yml)

[![MIT License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE)

A [Buildkite plugin] that invalidates AWS Cloudfront caches.

## Example

```yml

steps:

  - plugins:

      - envato/aws-cloudfront-invalidation#v0.1.0:

          distribution-id: 

          paths:

            - 

          debug: true

```

## Configuration

### `distribution-id`

The id of the Cloudfront distribution to create an invalidation for.

### `paths`

One or more [invalidation paths].

### `debug`

Adds the `--debug` flag to all AWS CLI commands, providing detailed output for troubleshooting.

## Development

To run the tests:

```sh

docker-compose run --rm tests

```

To run the [Buildkite Plugin Linter]:

```sh

docker-compose run --rm lint

```

[Buildkite plugin]: https://buildkite.com/docs/agent/v3/plugins

[Buildkite Plugin Linter]: https://github.com/buildkite-plugins/buildkite-plugin-linter

[invalidation paths]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects-paths