Question 1

How do I sync my S3 bucket with GitHub Actions using this action?

Accepted Answer

Create a workflow YAML file in .github/workflows, use the action with AWS credentials set as secrets, and specify sync arguments like --acl public-read and --delete, as shown in the README example for static websites.

Question 2

Is jakejarvis/s3-sync-action better than other S3 GitHub Actions?

Accepted Answer

It's best if you want direct AWS CLI control; alternatives like aws-actions/configure-aws-credentials with custom sync steps offer more flexibility but require extra setup. This action simplifies sync but limits customization to CLI flags.

Question 3

How to exclude files when syncing with s3-sync-action?

Accepted Answer

Use the --exclude flag in the args parameter, e.g., --exclude '.git/*' --exclude 'node_modules/*', with one flag per pattern and single quotes as advised in the README tips to prevent unintended uploads.

Question 4

Can I use this action with DigitalOcean Spaces instead of AWS S3?

Accepted Answer

Yes, set the AWS_S3_ENDPOINT environment variable to your Spaces endpoint and configure AWS credentials for Spaces, as mentioned in the configuration for non-AWS S3-compatible services.

Question 5

What AWS IAM permissions are needed for s3-sync-action?

Accepted Answer

Minimum permissions include s3:PutObject for uploads, s3:DeleteObject if using --delete, and s3:ListBucket for sync operations; refer to AWS docs for detailed policies based on your use case.

Question 6

How do I handle file deletions in S3 with this action safely?

Accepted Answer

Add the --delete flag to args to remove remote files not present locally, but test first in a staging bucket, as the README cautions it permanently deletes data and recommends careful use.

Sync/upload a directory to an AWS S3 bucket

What is Sync/upload a directory to an AWS S3 bucket?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions