Skip to content

ci: deploy documentation with reusable workflow - #321

Merged
zombieJ merged 1 commit into
masterfrom
agent/deploy-pages
Jul 27, 2026
Merged

ci: deploy documentation with reusable workflow#321
zombieJ merged 1 commit into
masterfrom
agent/deploy-pages

Conversation

@zombieJ

@zombieJ zombieJ commented Jul 27, 2026

Copy link
Copy Markdown
Member

Summary

  • deploy documentation on published releases and manual dispatches
  • reuse the shared react-component Pages workflow

Verification

  • validated by the shared Pages build after merge

Summary by CodeRabbit

  • 新功能
    • 新增文档页面自动部署流程,支持在发布版本后自动部署。
    • 支持手动触发文档部署。

@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@vercel

vercel Bot commented Jul 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
progress Ready Ready Preview, Comment Jul 27, 2026 9:28am

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

新增 GitHub Actions 文档部署工作流,支持发布完成或手动触发,并通过复用工作流部署 GitHub Pages。

Changes

文档部署

Layer / File(s) Summary
配置文档页面部署
.github/workflows/deploy-pages.yml
工作流在发布完成或手动触发时运行,配置内容读取、页面写入和身份令牌权限,并调用外部复用工作流执行部署。

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

我是小兔蹦蹦跳,
发布一到把页浇。
手动触发也不怕,
文档上线月光俏。

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 标题准确概括了使用可复用工作流部署文档这一主要变更。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/deploy-pages

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

React Doctor could not complete this scan.

react-doctor exited with status 0 before producing a JSON report.

Report this bug

Reviewed by React Doctor for commit c60ac80.

@codecov

codecov Bot commented Jul 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.35%. Comparing base (b55bf31) to head (c60ac80).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #321   +/-   ##
=======================================
  Coverage   99.35%   99.35%           
=======================================
  Files           7        7           
  Lines         156      156           
  Branches       52       51    -1     
=======================================
  Hits          155      155           
  Misses          1        1           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

github-actions Bot commented Jul 27, 2026

Copy link
Copy Markdown

❌ Deploy failed

PR preview ❌ Failed ❌ Failed
🔗 Preview https://react-component-progress-preview-pr-321.surge.sh (may be unavailable)
📝 Commitc60ac80
🪵 LogsView logs
📋 Build log (last lines)
npm error
npm error Could not resolve dependency:
npm error peer eslint@"^3 || ^4 || ^5 || ^6 || ^7 || ^8 || ^9.7" from eslint-plugin-react@7.37.5
npm error node_modules/eslint-plugin-react
npm error   dev eslint-plugin-react@"^7.37.5" from the root project
npm error   eslint-plugin-react@"^7.32.2" from @umijs/fabric@4.0.1
npm error   node_modules/@umijs/fabric
npm error     @umijs/fabric@"^4.0.0" from rc-test@7.1.3
npm error     node_modules/rc-test
npm error       dev rc-test@"^7.1.3" from the root project
npm error
npm error Conflicting peer dependency: eslint@9.39.5
npm error node_modules/eslint
npm error   peer eslint@"^3 || ^4 || ^5 || ^6 || ^7 || ^8 || ^9.7" from eslint-plugin-react@7.37.5
npm error   node_modules/eslint-plugin-react
npm error     dev eslint-plugin-react@"^7.37.5" from the root project
npm error     eslint-plugin-react@"^7.32.2" from @umijs/fabric@4.0.1
npm error     node_modules/@umijs/fabric
npm error       @umijs/fabric@"^4.0.0" from rc-test@7.1.3
npm error       node_modules/rc-test
npm error         dev rc-test@"^7.1.3" from the root project
npm error
npm error Fix the upstream dependency conflict, or retry
npm error this command with --force or --legacy-peer-deps
npm error to accept an incorrect (and potentially broken) dependency resolution.
npm error
npm error
npm error For a full report see:
npm error /home/runner/.npm/_logs/2026-07-27T09_29_34_344Z-eresolve-report.txt
npm error A complete log of this run can be found in: /home/runner/.npm/_logs/2026-07-27T09_29_34_344Z-debug-0.log

🤖 Powered by surge-preview

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/workflows/deploy-pages.yml:
- Line 15: 将 deploy-pages 可复用工作流的引用从不固定的 `@main` 更新为完整 commit SHA
1afe200f7e3a6ccbafbc6ed0142cb5762ae9ce02,保持现有工作流调用方式和权限配置不变。
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: aa352081-2e15-4e5e-a19d-75def668633a

📥 Commits

Reviewing files that changed from the base of the PR and between b55bf31 and c60ac80.

📒 Files selected for processing (1)
  • .github/workflows/deploy-pages.yml


jobs:
deploy:
uses: react-component/rc-test/.github/workflows/deploy-pages.yml@main

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔒 Security & Privacy | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -eu

sha="$(git ls-remote https://github.com/react-component/rc-test.git refs/heads/main | awk '{print $1}')"
test "${`#sha`}" -eq 40

workflow="$(curl -fsSL \
  "https://raw.githubusercontent.com/react-component/rc-test/${sha}/.github/workflows/deploy-pages.yml")"

printf '%s\n' "$workflow" | grep -Eq '^[[:space:]]+workflow_call:'
echo "Verified workflow SHA: ${sha}"

Repository: react-component/progress

Length of output: 226


🏁 Script executed:

#!/bin/bash
set -eu

sha="1afe200f7e3a6ccbafbc6ed0142cb5762ae9ce02"
workflow_file=".github/workflows/deploy-pages.yml"

printf '%s\n' "--- workflow_call/in-permissions/inputs section ---"
python3 - <<'PY'
import pathlib, re
p = pathlib.Path('.github/workflows/deploy-pages.yml')
text = p.read_text()
for pat in [r'(?m)^[ \t]*workflow_call:[ \t]*[\s\S]*?(?=^\S|\Z)',
            r'(?m)^[ \t]*permissions:([\s\S]*?)(?=^    [^ ]|^\Z)',
            r'(?m)^[ \t]*on:([\s\S]*?)(?=^    [^ ]|^\Z)']:
    m = re.search(pat, text)
    print(m.group(0) if m else '--- pattern not found: ' + pat + ' ---')
PY

printf '%s\n' "--- current use directive ---"
rg -n 'uses: react-component/rc-test/.github/workflows/deploy-pages.yml' "$workflow_file" -C 3

printf '%s\n' "--- target workflow relevant sections ---"
curl -fsSL "https://raw.githubusercontent.com/react-component/rc-test/${sha}/.github/workflows/deploy-pages.yml" | sed -n '1,220p'

Repository: react-component/progress

Length of output: 2003


将外部可复用工作流固定到完整 commit SHA。

当前使用 @main,上游分支后续变更仍会直接获得本仓库的 pages: writeid-token: write 权限。已确认可复用工作流声明了 workflow_call 且无必需输入,可直接替换为完整 SHA(1afe200f7e3a6ccbafbc6ed0142cb5762ae9ce02),避免上游变更或供应链攻击影响 Pages 部署。

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/deploy-pages.yml at line 15, 将 deploy-pages 可复用工作流的引用从不固定的
`@main` 更新为完整 commit SHA
1afe200f7e3a6ccbafbc6ed0142cb5762ae9ce02,保持现有工作流调用方式和权限配置不变。

@zombieJ
zombieJ merged commit 7061f0c into master Jul 27, 2026
12 of 14 checks passed
@zombieJ
zombieJ deleted the agent/deploy-pages branch July 27, 2026 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant