gatsby-uc/gatsby-plugin-s3

Add option for plugin to automatically create a CloudFront invalidation once deployment is complete

Open

#68 opened on May 25, 2019

View on GitHub
 (5 comments) (6 reactions) (0 assignees)TypeScript (104 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (206 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

This was discussed briefly in #47. Currently in our "with CloudFront" recipe and in my blog post we recommend invalidating the CloudFront cache after the deployment.

The mechanism suggested for this is to use the shell's && operator to execute both commands:

gatsby-plugin-s3 deploy --yes && aws cloudfront create-invalidation --distribution-id EXAMPLEDISTRIBUTIONID --paths \"/*\"

This is clunky, it would be nice to have gatsby-plugin-s3 take care of this.

By default I think we should NOT wait for the invalidation to complete, as this may take a long time. We could also add an option to wait for the invalidation to complete.

I suggest these options and defaults:

{
    'cloudfrontDistributionId': undefined,
    'createCloudfrontInvalidation': false,
    'waitForCloudfrontInvalidation': false
}

Contributor guide

Research direction
Implement new plugin options cloudfrontDistributionId, createCloudfrontInvalidation, waitForCloudfrontInvalidation. Modify the deploy logic to call AWS CloudFront create invalidation API after upload, optionally waiting for completion.
Tech stack
typescriptnodejs
Domain
cloudfrontenddevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GatsbyAWS S3CloudFront
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60