S3 Sync Action 使用教程

项目介绍

S3 Sync Action 是一个 GitHub Action，用于将本地目录与 AWS S3 存储桶同步。该项目使用 AWS CLI 进行同步操作，支持多种自定义配置，适用于自动化部署和持续集成/持续部署（CI/CD）流程。

项目快速启动

安装步骤

1. 在 GitHub 仓库中创建 .github/workflows 目录（如果尚未创建）。
2. 在该目录下创建一个新的 YAML 文件，例如 s3-sync.yml。
3. 将以下代码片段复制到 YAML 文件中：

name: S3 Sync
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: S3 Sync
      uses: jakejarvis/s3-sync-action@v0.5.1
      with:
        args: --acl public-read --follow-symlinks --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-west-1' # 根据需要更改区域
        SOURCE_DIR: 'public' # 同步的本地目录

配置说明

• AWS_S3_BUCKET: 目标 S3 存储桶名称。
• AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY: AWS 访问密钥和密钥 ID，建议通过 GitHub Secrets 存储。
• AWS_REGION: S3 存储桶所在区域。
• SOURCE_DIR: 需要同步的本地目录。

应用案例和最佳实践

应用案例

1. 静态网站部署: 使用 S3 Sync Action 将静态网站文件同步到 S3 存储桶，并通过 CloudFront 分发，实现快速访问。
2. 持续集成/持续部署: 在每次代码提交后，自动将代码构建结果同步到 S3，实现自动化部署。

最佳实践

1. 使用 Secrets 存储敏感信息: 将 AWS 访问密钥和密钥 ID 存储在 GitHub Secrets 中，避免敏感信息泄露。
2. 配置删除选项: 使用 --delete 选项，确保 S3 存储桶中的文件与本地目录保持一致。
3. 优化同步参数: 根据具体需求配置 --acl public-read 和 --follow-symlinks 等选项，提高同步效率和安全性。

典型生态项目

相关项目

1. AWS CLI: S3 Sync Action 依赖 AWS CLI 进行同步操作，确保 AWS CLI 版本兼容。
2. GitHub Actions: 使用 GitHub Actions 进行自动化工作流管理，结合 S3 Sync Action 实现自动化部署。
3. CloudFront: 结合 AWS CloudFront 进行内容分发，提高静态网站访问速度。

通过以上步骤和配置，您可以快速上手并使用 S3 Sync Action 进行自动化部署和持续集成/持续部署。