Skip to content

ci: deploy documentation with reusable workflow - #1083

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

ci: deploy documentation with reusable workflow#1083
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

  • 新功能
    • 新增文档自动部署流程,支持在发布完成后自动部署到 GitHub Pages。
    • 支持手动触发文档部署。

@gemini-code-assist

Copy link
Copy Markdown
Contributor

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)
slider Ready Ready Preview, Comment Jul 27, 2026 9:53am

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

新增 GitHub Pages 文档部署工作流,支持发布完成后或手动触发,并复用远程工作流执行部署。

Changes

文档部署

Layer / File(s) Summary
配置文档部署工作流
.github/workflows/deploy-pages.yml
新增 Deploy documentation 工作流,监听已发布的 release 和手动触发,配置 Pages 写入、内容读取及身份令牌权限,并调用远程部署工作流。

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

Poem

我是小兔蹦蹦跳,
Pages 部署安排好。
发布一到文档飞,
手动触发也可靠。
胡萝卜旁敲键盘,
月光下把网页照。

🚥 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 f431a74.

@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 98.66%. Comparing base (3e6a228) to head (f431a74).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1083   +/-   ##
=======================================
  Coverage   98.66%   98.66%           
=======================================
  Files          15       15           
  Lines         751      751           
  Branches      234      234           
=======================================
  Hits          741      741           
  Misses         10       10           

☔ 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.

@zombieJ
zombieJ merged commit 22b0226 into master Jul 27, 2026
11 of 14 checks passed
@zombieJ
zombieJ deleted the agent/deploy-pages branch July 27, 2026 09:53
@github-actions

github-actions Bot commented Jul 27, 2026

Copy link
Copy Markdown

❌ Deploy failed

PR preview ❌ Failed ❌ Failed
🔗 Preview https://react-component-slider-preview-pr-1083.surge.sh (may be unavailable)
📝 Commitf431a74
🪵 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_54_14_109Z-eresolve-report.txt
npm error A complete log of this run can be found in: /home/runner/.npm/_logs/2026-07-27T09_54_14_109Z-debug-0.log

🤖 Powered by surge-preview

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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: Update the reusable workflow reference in the deploy-pages workflow
to pin react-component/rc-test/.github/workflows/deploy-pages.yml to the
reviewed full commit SHA instead of the mutable main branch, while preserving
the existing workflow and permissions.
🪄 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: 4a1ddced-a792-4ce8-8605-49abcc7c17cf

📥 Commits

Reviewing files that changed from the base of the PR and between 3e6a228 and f431a74.

📒 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
Contributor

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 -euo pipefail

sha="<reviewed-full-commit-sha>"
git ls-remote --exit-code https://github.com/react-component/rc-test.git "$sha"

Repository: react-component/slider

Length of output: 160


🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== workflow file =="
if [ -f .github/workflows/deploy-pages.yml ]; then
  cat -n .github/workflows/deploy-pages.yml
else
  echo ".github/workflows/deploy-pages.yml not found"
fi

echo
echo "== remote repo references =="
git ls-remote --exit-code --heads https://github.com/react-component/rc-test.git || true
echo
git ls-remote --exit-code --tags https://github.com/react-component/rc-test.git || true

echo
echo "== usages =="
rg -n "uses: react-component/rc-test/.github/workflows/deploy-pages.yml|id-token: write|pages: write" .github/workflows || true

Repository: react-component/slider

Length of output: 5042


将可复用工作流固定到完整提交 SHA。

react-component/rc-test/.github/workflows/deploy-pages.yml@main 使用可变分支,上游后续变更会直接改变文档发布流程;该工作流还包含 pages: writeid-token: write 权限,应改为已审查的完整 commit SHA。

🤖 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, Update the reusable workflow
reference in the deploy-pages workflow to pin
react-component/rc-test/.github/workflows/deploy-pages.yml to the reviewed full
commit SHA instead of the mutable main branch, while preserving the existing
workflow and permissions.

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