docs: update publish docs (#47809) #2269
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# When pushing a tag. this workflow will trigger site deployment and fixed version address comments | |
name: Deploy website | |
on: | |
push: | |
tags: | |
- '5.*' | |
workflow_dispatch: | |
permissions: | |
contents: write | |
jobs: | |
setup: | |
runs-on: ubuntu-latest | |
if: (startsWith(github.ref, 'refs/tags/') && (contains(github.ref_name, '-') == false)) || github.event_name == 'workflow_dispatch' | |
steps: | |
- name: checkout | |
uses: actions/checkout@v4 | |
- name: cache package-lock.json | |
uses: actions/cache@v4 | |
with: | |
path: package-temp-dir | |
key: lock-${{ github.sha }} | |
- name: create package-lock.json | |
run: npm i --package-lock-only --ignore-scripts | |
- name: hack for single file | |
run: | | |
if [ ! -d "package-temp-dir" ]; then | |
mkdir package-temp-dir | |
fi | |
cp package-lock.json package-temp-dir | |
- name: cache node_modules | |
id: node_modules_cache_id | |
uses: actions/cache@v4 | |
with: | |
path: node_modules | |
key: node_modules-${{ hashFiles('**/package-temp-dir/package-lock.json') }} | |
- name: install | |
if: steps.node_modules_cache_id.outputs.cache-hit != 'true' | |
run: npm ci | |
build-and-deploy: | |
runs-on: ubuntu-latest | |
needs: setup | |
steps: | |
- name: checkout | |
uses: actions/checkout@v4 | |
- uses: actions/setup-node@v4 | |
with: | |
node-version: 18 | |
- name: restore cache from package-lock.json | |
uses: actions/cache@v4 | |
with: | |
path: package-temp-dir | |
key: lock-${{ github.sha }} | |
- name: restore cache from node_modules | |
uses: actions/cache@v4 | |
with: | |
path: node_modules | |
key: node_modules-${{ hashFiles('**/package-temp-dir/package-lock.json') }} | |
- name: build site | |
run: npm run predeploy | |
env: | |
NODE_OPTIONS: "--max_old_space_size=4096" | |
- name: build dist and bundle analyzer report | |
run: npm run dist | |
env: | |
ANALYZER: 1 | |
NODE_OPTIONS: "--max_old_space_size=4096" | |
- name: Get version | |
id: publish-version | |
run: echo "VERSION=$(echo ${{ github.ref_name }} | sed 's/\./-/g')" >> $GITHUB_OUTPUT | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./_site | |
force_orphan: true | |
# Since force_orphan will not trigger Sync to Gitee, we need to force run it here | |
- name: Sync to Gitee | |
uses: wearerequired/git-mirror-action@v1 | |
env: | |
SSH_PRIVATE_KEY: ${{ secrets.GITEE_SSH_PRIVATE_KEY }} | |
with: | |
source-repo: 'git@github.com:ant-design/ant-design.git' | |
destination-repo: 'git@gitee.com:ant-design/ant-design.git' | |
- name: Deploy to Surge (with TAG) | |
run: | | |
export DEPLOY_DOMAIN=ant-design-${{ steps.publish-version.outputs.VERSION }}.surge.sh | |
cp report.html ./_site | |
npx surge --project ./_site --domain $DEPLOY_DOMAIN --token ${{ secrets.SURGE_TOKEN }} | |
- name: Create Commit Comment | |
uses: peter-evans/commit-comment@v3 | |
with: | |
body: | | |
- Documentation site for this release: https://ant-design-${{ steps.publish-version.outputs.VERSION }}.surge.sh | |
- Webpack bundle analyzer report page: https://ant-design-${{ steps.publish-version.outputs.VERSION }}.surge.sh/report.html | |