⚠️ Note: To use this action, you must have access to the GitHub Actions feature. GitHub Actions are currently only available in public beta. You can apply for the GitHub Actions beta here.
This simple action uses the vanilla AWS CLI to sync a directory (either from your repository or generated during your workflow) with a remote S3 bucket.
Performing this action deletes any files in the bucket that are not present in the source directory. Working on making this optional in the next release!
Place in a .yml file such as this one in your .github/workflows folder. Refer to the documentation on workflow YAML syntax here.
name: Sync Bucket
on: push
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: jakejarvis/s3-sync-action@master
env:
SOURCE_DIR: './public'
AWS_REGION: 'us-east-1'
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 }}
| Key | Value | Type | Required |
|---|---|---|---|
SOURCE_DIR |
The local directory you wish to sync/upload to S3. For example, ./public. |
env |
Yes |
AWS_REGION |
The region where you created your bucket in. For example, us-east-1. Full list of regions here. |
env |
Yes |
The following variables should be added as "secrets" in the action's configuration.
| Key | Value | Type | Required |
|---|---|---|---|
AWS_S3_BUCKET |
The name of the bucket you're syncing to. For example, jarv.is. |
secret |
Yes |
AWS_ACCESS_KEY_ID |
Your AWS Access Key. More info here. | secret |
Yes |
AWS_SECRET_ACCESS_KEY |
Your AWS Secret Access Key. More info here. | secret |
Yes |
This project is distributed under the MIT license.