GitHub Action to Sync S3 Bucket

This is a fork of jakejarvis/s3-sync-action which works around an issue with aws-cli applying an incorrect charset in MIME guessing mode. Due to how long outstanding this issue is, it seems unlikely it will be fixed. See aws/aws-cli#1346.

This action is based on the above, but does not invoke aws-cli, instead using its own system to sync the source and destination directory. As such, it lacks several options found in the parent GitHub workflow action. The intended use case is uploading built files to a destination subdirectory in S3, replacing any existing contents.

You may use this action if you wish, bear in mind it was created to upload (primarily CSS theme) assets to cdn.scpwiki.com. See an example workflow: https://github.com/scpwiki/sigma/blob/main/.github/workflows/deploy.yaml

Usage

Options

• --delete permanently deletes files in the S3 bucket under DEST_DIR which are not present in your latest build.
• --follow-symlinks causes any symbolic links in the source directory to be followed. Note: if your linked directory structure is recursive, this can lead to an infinite loop.
• --exclude <DIRECTORY> skips the given directory or path when scanning, causing it to not be uploaded. Can be specified multiple times. Does not accept wildcards.
• --endpoint <URL> specifies a custom endpoint URL. See VPC scenarios and DigitalOcean Spaces.

workflow.yaml Example

Place in a .yaml file such as this one in your .github/workflows folder. Refer to the documentation on workflow YAML syntax here.

name: Upload Website

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: emmiegit/s3-sync-action@main
      with:
        args: --delete
      env:
        AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        AWS_REGION: 'us-east-2'
        SOURCE_DIR: 'public'      # optional: defaults to entire repository
        DEST_DIR: 'blog'          # optional: defaults to root of bucket

Configuration

The following settings must be passed as environment variables as shown in the example. Sensitive information, especially AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY, should be set as encrypted secrets — otherwise, they'll be public to anyone browsing your repository's source code and CI logs.

Key	Value	Suggested Type	Required	Default
AWS_ACCESS_KEY_ID	Your AWS Access Key. More info here.	secret env	Yes	N/A
AWS_SECRET_ACCESS_KEY	Your AWS Secret Access Key. More info here.	secret env	Yes	N/A
AWS_S3_BUCKET	The name of the bucket you're syncing to. For example, jarv.is or my-app-releases.	secret env	Yes	N/A
AWS_REGION	The region where you created your bucket. Set to us-east-1 by default. Full list of regions here.	env	Yes	N/A
SOURCE_DIR	The local directory (or file) you wish to sync/upload to S3. For example, public. Defaults to your entire repository.	env	No	./ (root of cloned repository)
DEST_DIR	The directory inside of the S3 bucket you wish to sync/upload to. For example, my_project/assets. Defaults to the root of the bucket.	env	No	/ (root of bucket)

License

This project is distributed under the MIT license.