You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
AWS S3 Sync & Clean
v0.0.5
A GitHub Action to sync files to S3.
- Sync based on contents hash (includes accurate ETAG comparisons, even for multipart uploads)
- Parallel uploads with configurable concurrency & multipart chunk sizes
- Bucket prefixes
- Clean an object path (remove a "directory")
- Custom Cache-Control headers
- Glob path patterns
- Custom ACL
- Automatic Content-Type detection
- Strip extension from filename
Please read: https://github.com/aws-actions/configure-aws-credentials#credentials
name: 'Sync S3'
concurrency:
group: prod_deploy
cancel-in-progress: false
on:
repository_dispatch:
workflow_dispatch:
push:
branches:
- main
jobs:
deploy:
name: 'Sync'
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v1
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
aws-region: us-east-1
- uses: badsyntax/[email protected]
name: Sync HTML files to S3
id: sync-html-s3
with:
bucket: ${{ steps.update-stack.outputs.S3BucketName }}
action: 'sync' # sync|clean
src-dir: './out' # required only if action is sync
files-glob: '**/*.html' # required only if action is sync
aws-region: 'us-east-1'
prefix: 'preview'
strip-extension-glob: '**/**.html'
cache-control: 'public,max-age=0,s-maxage=31536000,must-revalidate'
- name: Output Synced Files
run: |
echo "Synced object keys: $S3SyncedFiles"
env:
# Use outputs from previous sync steps
S3SyncedFiles: ${{ steps.sync-html-s3.outputs.modified-keys }}| Name | Description | Example |
|---|---|---|
bucket |
The name of the S3 bucket | example-bucket-us-east-1 |
action |
The action to perform. Accepted values: sync or clean |
sync |
src-dir |
Source directory of local files to sync (if using the sync action) | ./src |
files-glob |
Glob pattern for source files to sync to S3 (if using the sync action) | **/*.html |
aws-region |
The AWS region | us-east-1 |
cache-control |
Cache-control headers | public,max-age=31536000,immutable |
prefix (optional) |
The prefix for the uploaded object | custom/folder |
strip-extension-glob (optional) |
Glob pattern to strip extension (if using the sync action) | **/**.html |
acl (optional) |
Access control list (options: authenticated-read, aws-exec-read, bucket-owner-full-control, bucket-owner-read, private, public-read, public-read-write) |
private |
multipart-file-size-mb (optional) |
The minimum file size, in megabytes, for which to upload files using multipart. The default is 100 |
100 |
multipart-chunk-bytes (optional) |
The chunk size, in bytes, to upload multipart file parts in. The default is 10485760 (10MB) |
10485760 |
concurrency (optional) |
How many processes to perform at once. The default is 6 |
6 |
| Name | Description | Example |
|---|---|---|
modified-keys |
A comma separated list of modified object keys (either synced or removed) | file1,folder1/file2.ext |
The aws cli syncs files based on file modified times or file size. This approach is not ideal when syncing in CI or when build hashes might change but file size is unchanged.
This Action compares the md5 hash against the uploaded file, and if there's a match it will not sync the file.
Check the Action output for logs.
If you need to see more verbose logs you can set ACTIONS_STEP_DEBUG to true as an Action Secret.
See LICENSE.md.