fangbinwei/aliyun-oss-website-action

aliyun-oss-website-action

镜像概述和主要用途

aliyun-oss-website-action 是一个GitHub Action，用于将静态网站资源自动部署到阿里云OSS（对象存储服务）。通过配置该Action，可在代码推送等事件触发时，自动清除OSS Bucket中原有文件，上传新生成的网站资源，并配置静态页面和缓存策略，结合阿里云CDN可实现网站加速访问。

核心功能和特性

• 自动部署：触发后自动清除Bucket旧文件并上传新资源
• 静态页面配置：自动设置网站首页（默认index.html）和404页面（默认404.html）
• 缓存控制：为不同类型资源（HTML、图片、其他文件）设置默认缓存策略
• 文件排除：支持排除指定文件或文件夹不上传
• 灵活配置：支持自定义Endpoint、CNAME、缓存策略等参数
• CDN集成：可配合阿里云CDN实现网站加速，支持HTTPS

使用场景和适用范围

• 静态网站（如VuePress、Vue、React等框架生成的单页应用）的自动化部署
• 需要通过阿里云OSS托管网站并利用CDN加速访问的场景
• 希望通过GitHub Action实现代码推送后自动更新网站内容的开发流程

使用方法和配置说明

基本使用示例

yml
- name: upload files to OSS
  uses: fangbinwei/aliyun-oss-website-action@v1
  with:
      accessKeyId: ${{ secrets.ACCESS_KEY_ID }}
      accessKeySecret: ${{ secrets.ACCESS_KEY_SECRET }}
      bucket: your-bucket-name
      endpoint: oss-cn-shanghai.aliyuncs.com  # 使用实际Endpoint
      folder: your-website-output-folder  # 网站资源输出目录

配置项说明

缓存控制策略

默认Cache-Control设置如下：

静态页面配置

默认情况下，Action会自动配置OSS静态页面设置，将首页设为index.html，404页面设为404.html。若需手动配置，可设置skipSetting: true跳过自动配置。

排除文件/文件夹

通过exclude参数可指定不上传的文件或文件夹，支持简单通配符（不支持**）：

yml
- name: exclude some files
  uses: fangbinwei/aliyun-oss-website-action@v1
  with:
    folder: dist
    exclude: |
      tmp.txt
      tmp/
      tmp2/*.txt
      tmp2/*/*.txt
  # 匹配 dist/tmp.txt、dist/tmp/、dist/tmp2/a.txt、dist/tmp2/a/b.txt
  # 不匹配 dist/tmp2/tmp3/a/b.txt

Docker镜像使用

也可直接使用预构建的Docker镜像，通过环境变量传递参数：

yml
- name: upload files to OSS
  uses: docker://fangbinwei/aliyun-oss-website-action:v1
  env:
      ACCESS_KEY_ID: ${{ secrets.ACCESS_KEY_ID }}
      ACCESS_KEY_SECRET: ${{ secrets.ACCESS_KEY_SECRET }}
      BUCKET: your-bucket-name
      ENDPOINT: ali-oss-endpoint
      FOLDER: your-website-output-folder

部署示例

VuePress项目部署

yml
name: deploy vuepress

on:
  push:
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
            repository: fangbinwei/blog
            fetch-depth: 0
      - name: Use Node.js
        uses: actions/setup-node@v1
        with:
          node-version: '12'
      - run: npm install yarn@1.22.4 -g
      - run: yarn install
      - run: yarn docs:build  # 打包文档命令
      - name: upload files to OSS
        uses: fangbinwei/aliyun-oss-website-action@v1
        with:
            accessKeyId: ${{ secrets.ACCESS_KEY_ID }}
            accessKeySecret: ${{ secrets.ACCESS_KEY_SECRET }}
            bucket: "your-bucket-name"
            endpoint: "oss-cn-shanghai.aliyuncs.com" 
            folder: ".vuepress/dist"

Vue项目部署

yml
- name: upload files to OSS
  uses: fangbinwei/aliyun-oss-website-action@v1
  with:
      accessKeyId: ${{ secrets.ACCESS_KEY_ID }}
      accessKeySecret: ${{ secrets.ACCESS_KEY_SECRET }}
      bucket: website-spa-vue-demo
      endpoint: oss-spa-demo.fangbinwei.cn
      cname: true
      folder: dist
      notFoundPage: index.html
      htmlCacheControl: no-cache
      imageCacheControl: max-age=864001
      otherCacheControl: max-age=2592001

常见问题（FAQ）

OSS更新后CDN未刷新

开启OSS的CDN缓存自动刷新功能，将触发操作配置为PutObject和DeleteObject。

Endpoint使用自定义域名无法上传

1. 若CDN配置了HTTP强制跳转HTTPS，需在Endpoint中指定HTTPS协议（如https://example.org）。
2. 若CDN加速范围为全球，可能出现端点错误，此时需使用OSS源站Endpoint而非自定义域名。

环境变量（environment secret）不生效

若使用环境变量，需在job中指定环境名称：

diff
jobs:
  build:
    runs-on: ubuntu-latest
+   environment: your-environment-name