Files
composite-actions/deploy-dist-to-surge/action.yml
严浩 661c7b87c1 Feat/surge customizable dirs (#49)
* feat: Allow customizing working_dir and dist_dir for Surge deployment

This commit introduces two new optional inputs to the `deploy-dist-to-surge` action:

- `working_dir`: Specifies the directory from which the Surge command should be run. Defaults to the repository root (`.`).
- `dist_dir`: Specifies the directory containing the built assets to deploy, relative to `working_dir`. Defaults to `dist`.

These changes provide more flexibility for projects where the build output is not in the default `dist` folder at the root of the repository.

Updated README.md with details on the new inputs and an example usage.

* feat: Allow customizing working_dir and dist_dir for Surge deployment

This commit introduces two new optional inputs to the `deploy-dist-to-surge` action:

- `working_dir`: Specifies the directory from which the Surge command should be run. Defaults to the repository root (`.`).
- `dist_dir`: Specifies the directory containing the built assets to deploy, relative to `working_dir`. Defaults to `dist`.

These changes provide more flexibility for projects where the build output is not in the default `dist` folder at the root of the repository.

Updated README.md with details on the new inputs and an example usage.
Also updated the test workflow `.github/workflows/deploy-dist-to-surge-tetst.yaml` to utilize and verify these new inputs.

* feat: 支持唯一测试域名并更新中文描述

此提交为 `deploy-dist-to-surge` 操作引入了 `domain_suffix` 输入,以允许在同一工作流程中为多次部署生成唯一的 Surge 域名,这对于测试至关重要。

同时包含先前对 `working_dir` 和 `dist_dir` 输入的支持,并更新了 `action.yml` 和 `README.md` 中的所有相关描述为中文。

测试工作流程已更新以使用 `domain_suffix` 并验证自定义目录和默认目录的部署。

---------

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
2025-07-05 11:56:31 +08:00

38 lines
1.8 KiB
YAML

name: "Deploy dist to Surge"
description: "部署 dist 到 Surge"
inputs:
working_dir:
description: '执行 Surge 部署的工作目录。默认为仓库根目录。'
required: false
default: '.'
dist_dir:
description: '包含要部署的构建产物的目录。如果指定了 `working_dir`,则相对于 `working_dir`,否则相对于仓库根目录。'
required: false
default: 'dist'
domain_suffix:
description: '部署时用于创建唯一域名的后缀(例如,用于在同一工作流程中测试多个实例)。最终域名将是 `<sha><suffix>.surge.sh`。'
required: false
default: ''
outputs:
url:
description: "Preview URL"
value: ${{ steps.surge_deploy.outputs.url }}
runs:
using: "composite"
steps:
- name: 部署到 Surge
shell: bash
id: surge_deploy
# https://github.com/afc163/surge-preview
# https://github.com/Tencent/tdesign-vue-next/pull/1604#issuecomment-1236244550
# https://github.com/Tencent/tdesign-vue-next/blob/03036a19adccf4657d7792e3a61a6c6a7d902e3e/.github/workflows/preview-publish.yml
# https://github.com/Tencent/tdesign/blob/0c0c9b63897c05d10c58e1a1e36feda2cb99eca7/.github/workflows/preview.yml#L40
run: |
if [ "${{ inputs.working_dir }}" != "." ]; then cd ${{ inputs.working_dir }}; fi
export DEPLOY_DOMAIN_PREFIX=${{ github.sha }}${{ inputs.domain_suffix }}
export DEPLOY_DOMAIN=https://${DEPLOY_DOMAIN_PREFIX}.surge.sh
cp ${{ inputs.dist_dir }}/index.html ${{ inputs.dist_dir }}/200.html
npx surge --project ./${{ inputs.dist_dir }} --domain $DEPLOY_DOMAIN --token d843de16b331c626f10771245c56ed93 # npx surge token
echo the preview URL is $DEPLOY_DOMAIN
echo "url=$DEPLOY_DOMAIN" >> $GITHUB_OUTPUT