s3-deploy：轻松部署静态网站至AWS S3

s3-deploy：轻松部署静态网站至AWS S3

s3-deploy Easily deploy a static website to AWS S3 and invalidate CloudFront distribution 项目地址: https://gitcode.com/gh_mirrors/s3/s3-deploy

项目介绍

s3-deploy 是一个基于 GitHub Action 的开源项目，它能够帮助开发者轻松地将静态网站部署到 AWS S3，并支持对 CloudFront 分发进行失效处理。这个项目是基于 import-io 的 s3-deploy 包进一步开发而来，它提供了一系列的配置选项，以适应不同的部署需求。

项目技术分析

s3-deploy 利用 GitHub Action 的自动化特性，允许开发者通过配置 workflow.yml 文件来定义部署流程。该流程包括检查代码更改、安装依赖、构建项目，并最终使用 s3-deploy Action 来上传文件到指定的 S3 存储桶中。以下是该项目的关键技术点：

• GitHub Action：自动化构建、测试和部署工作流程。
• AWS S3：用于存储静态网站文件的云存储服务。
• CloudFront：AWS 的内容分发网络（CDN），用于加速内容的全球分发。

项目及技术应用场景

s3-deploy 的主要应用场景包括但不限于以下几种情况：

1. 静态网站部署：适用于个人博客、企业官网、文档站等不需要服务器端逻辑的静态网站。
2. 自动化部署：通过集成到持续集成/持续部署（CI/CD）流程中，实现代码自动部署，提高开发效率。
3. 版本控制与发布：通过管理不同版本的部署，可以方便地回滚到之前的状态，或者进行蓝绿部署。

以下是使用 s3-deploy 的典型步骤：

1. 在 GitHub 仓库中创建 workflow.yml 文件。
2. 配置 AWS 的 IAM 权限，确保 Action 具有上传和删除 S3 文件的权限。
3. 设置 GitHub Secrets，存储 AWS 的访问密钥和 S3 存储桶信息。
4. 触发 GitHub Action，自动执行部署流程。

项目特点

s3-deploy 项目的特点如下：

• 易于配置：通过简单的 YAML 配置即可实现自动化部署。
• 灵活性：提供了多种配置选项，如是否删除不再存在的文件、设置缓存控制、上传私有文件等。
• 高效性：支持并行上传和文件选择性包含，提高部署效率。
• 安全性：通过 IAM 策略和 GitHub Secrets 机制，确保部署过程的安全。

以下是 s3-deploy 支持的一些配置参数：

| 参数名 | 类型 | 必填 | 默认值 | 描述 | | ----------------- | ---------------- | ------ | --------- | ------------------------------------------------------------------------------------------ | | folder | string | 是 | 无 | 要上传的文件夹名称 | | bucket | string | 是 | 无 | 目标 S3 存储桶名称 | | bucket-region | string | 是 | 无 | 目标存储桶所在的区域 | | dist-id | string | 否 | undefined | CloudFront 分发 ID，用于失效处理 | | invalidation | string | 否 | '/' | CloudFront 分发失效的路径 | | delete-removed | boolean / string | 否 | false | 删除在本地不存在但在 S3 中的文件 | | noCache | boolean | 否 | false | 添加 Cache-Control: no-cache, no-store, must-revalidate 头信息 | | private | boolean | 否 | false | 以私有访问控制列表（ACL）上传文件，适用于 S3 静态网站托管 | | cache | string | 否 | 无 | 设置 Cache-Control: max-age=X 头信息 | | immutable | boolean | 否 | false | 设置 Cache-Control 头信息为 'immutable' | | cache-control | string | 否 | 无 | 设置自定义的 Cache-Control 头信息 | | files-to-include| string | 否 | "**" | 用于匹配要包含在部署中的文件的 glob 模式，用逗号分隔 |

通过以上的配置，s3-deploy 项目的功能强大且易于使用，是静态网站部署到 AWS S3 的理想选择。

s3-deploy Easily deploy a static website to AWS S3 and invalidate CloudFront distribution 项目地址: https://gitcode.com/gh_mirrors/s3/s3-deploy