Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
upload-cloud

GitHub Action

S3 Deploy

v2.0.1

S3 Deploy

upload-cloud

S3 Deploy

Deploy a static website to AWS S3 and invalidate CloudFront distribution

Installation

Copy and paste the following snippet into your .yml file.

              

- name: S3 Deploy

uses: Reggionick/[email protected]

Learn more about this action in Reggionick/s3-deploy

Choose a version

AWS S3 Deploy GitHub Action

Easily deploy a static website to AWS S3 and invalidate CloudFront distribution

This action is based on the work done by import-io on s3-deploy.

Usage

You can use this action by referencing the v2 branch

uses: reggionick/s3-deploy@v2
with:
    folder: build
    bucket: ${{ secrets.S3_BUCKET }}
    dist-id: ${{ secrets.CLOUDFRONT_DISTRIBUTION_ID }}

Arguments

S3 Deploy's Action supports inputs from the user listed in the table below:

Input Type Required Default Description
folder string Yes The folder to upload
bucket string Yes The destination bucket
bucket-region string Yes The destination bucket region
dist-id string Yes The CloudFront Distribution ID to invalidate
invalidation string No '/' The CloudFront Distribution path(s) to invalidate
delete-removed boolean / string No false Removes files in S3, that are not available in the local copy of the directory

Example workflow.yml with S3 Deploy Action

name: Example workflow for S3 Deploy
on: [push]
jobs:
  run:
    runs-on: ubuntu-latest
    env:
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
    steps:
        - uses: actions/checkout@v2

        - name: Install dependencies
          run: yarn

        - name: Build
          run: yarn build

        - name: Deploy
          uses: reggionick/s3-deploy@v2
          with:
            folder: build
            bucket: ${{ secrets.S3_BUCKET }}
            bucket-region: ${{ secrets.S3_BUCKET_REGION }}
            dist-id: ${{ secrets.CLOUDFRONT_DISTRIBUTION_ID }}
            invalidation: /
            delete-removed: true

License

The code in this project is released under the MIT License.