feat(ci): Bump yscope-dev-utils to y-scope/yscope-dev-utils@38bf51e; Add coverage for building docs; Bump `actions/checkout` to v6.0.2; Fix task paths in `taskfiles/docs.yaml`. by Bill-hbrhbr · Pull Request #298 · y-scope/spider

Bill-hbrhbr · 2026-04-04T17:23:04Z

Description

#297 broke paths in the taskfiles/docs.yaml due to file relocation. This PR fixes those paths and adds CI coverage for docs builds so potential issues will be caught in future PRs.

Checklist

The PR satisfies the contribution guidelines.
This is a breaking change and that has been indicated in the PR title, OR this isn't a
breaking change.
Necessary docs have been updated, OR no docs need to be updated.

Validation performed

New docs CI passes.

Summary by CodeRabbit

New Features
- Added an automated documentation build workflow that runs on PRs, schedule and and manual triggers across supported platforms.
Chores
- Pinned CI checkout to a specific revision for more stable runs.
- Replaced third‑party setup steps with repository‑local installer and logging actions (Python, Java, Go task runner, UV).
- Updated dev‑utils submodule reference and its remote URL.
Chores
- Removed a previously provided reusable composite action for installing the Go task runner.

coderabbitai · 2026-04-04T17:23:20Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

Walkthrough

Removed a repo composite action that installed go-task; added a docs workflow; switched workflows to a pinned checkout SHA and repository-local install/log actions under tools/yscope-dev-utils; updated taskfiles to use absolute docs paths; and updated the tools/yscope-dev-utils submodule URL and commit.

Changes

Cohort / File(s)	Summary
Deleted composite action `.github/actions/install-go-task/action.yaml`	Removed the reusable composite GitHub Action that installed `go-task`.
Workflows — checkout pin & repo-local actions `.github/workflows/code-linting-checks.yaml`, `.github/workflows/tdl-generated-code-checks.yaml`, `.github/workflows/tests.yaml`	Replaced `actions/checkout@v4` with a pinned checkout commit SHA (de0fac2e... / v6.0.2). Switched third‑party/setup steps (Python, Java, go-task, logging) to repo-local composite actions under `./tools/yscope-dev-utils/exports/github/actions/` and added `install-uv` where applicable.
New docs workflow `.github/workflows/docs.yaml`	Added `docs` workflow (push/PR path filters, cron, workflow_dispatch) with matrix over `os` and `task`; uses recursive checkout, repo-local install/log actions, and runs `task docs:${{matrix.task}}:site`.
Taskfile docs configuration `taskfiles/docs.yaml`	Changed docs inputs to absolute `{{.ROOT_DIR}}/docs/...`, updated `SRC_DIR` usage, made Sphinx invocation use `--conf-dir "{{.SRC_DIR}}/conf"` with explicit source/output args, and updated docs-venv requirements path.
Submodule and tooling pointer updates `.gitmodules`, `tools/yscope-dev-utils`	Changed `.gitmodules` URL for `tools/yscope-dev-utils` and advanced the submodule commit reference to a newer commit.

Sequence Diagram(s)

sequenceDiagram
  participant GH as GitHub
  participant Runner as Runner (macOS/Ubuntu)
  participant Checkout as "actions/checkout (pinned)"
  participant LocalActions as "repo-local actions (tools/yscope-dev-utils)"
  participant Task as "task (go-task)"
  participant Sphinx as Sphinx

  GH->>Runner: trigger workflow (push/PR/cron/dispatch)
  Runner->>Checkout: checkout repo (recursive submodules)
  Runner->>LocalActions: run install-python, install-go-task, install-uv, log-tool-versions
  Runner->>Task: execute task docs:${matrix.task}:site
  Task->>Sphinx: invoke Sphinx --conf-dir "{{.SRC_DIR}}/conf" "{{.SRC_DIR}}/src" "{{.OUTPUT_DIR}}"
  Sphinx-->>Runner: produce site artifacts / logs
  Runner-->>GH: upload artifacts / report status

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title comprehensively summarizes the main changes: bumping yscope-dev-utils, adding docs CI coverage, bumping actions/checkout, and fixing task paths—all of which are reflected in the changeset.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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 and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/actions/repo-checkout/action.yaml:
- Around line 1-10: The composite local action "repo-checkout" is being
referenced before the repo is checked out; replace every use of the local
composite action (./.github/actions/repo-checkout) in the workflows (tests.yaml,
code-linting-checks.yaml, tdl-generated-code-checks.yaml, docs.yaml) with a
direct checkout step that uses
actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd and include with:
submodules: "recursive" so the runner can resolve files; remove the bootstrap
usage of the local composite action entirely so checkout happens first and
workflows no longer fail with "Can't find action.yaml/action.yml".

🪄 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: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 31ba06d9-a547-46a2-b78e-6433ef6164f0

📥 Commits

Reviewing files that changed from the base of the PR and between af7e0d8 and da741bd.

📒 Files selected for processing (6)

.github/actions/install-go-task/action.yaml
.github/actions/repo-checkout/action.yaml
.github/workflows/code-linting-checks.yaml
.github/workflows/docs.yaml
.github/workflows/tdl-generated-code-checks.yaml
.github/workflows/tests.yaml

coderabbitai

🧹 Nitpick comments (1)

.github/workflows/tdl-generated-code-checks.yaml (1)
25-27: Explicitly set the Java version in the install-java action.

The install-java composite action exposes a version input parameter (default: 11), but the workflow on line 25 does not set it explicitly. To prevent parser generation from drifting if the default version changes, add the version parameter:
- uses: "./tools/yscope-dev-utils/exports/github/actions/install-java"
  with:
    version: "11"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/tdl-generated-code-checks.yaml around lines 25 - 27, The
workflow uses the composite action "install-java" without explicitly setting its
version input; update the step that uses
"./tools/yscope-dev-utils/exports/github/actions/install-java" to include the
with: version: "11" parameter so the Java major version is pinned (do not change
the "install-go-task" step).

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/workflows/tdl-generated-code-checks.yaml:
- Around line 25-27: The workflow uses the composite action "install-java"
without explicitly setting its version input; update the step that uses
"./tools/yscope-dev-utils/exports/github/actions/install-java" to include the
with: version: "11" parameter so the Java major version is pinned (do not change
the "install-go-task" step).

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: cc1ef391-3c1d-478c-868c-ef08d13360b6

📥 Commits

Reviewing files that changed from the base of the PR and between 4147b4e and 1aff49c.

📒 Files selected for processing (2)

.github/workflows/tdl-generated-code-checks.yaml
tools/yscope-dev-utils

🚧 Files skipped from review as they are similar to previous changes (1)

tools/yscope-dev-utils

LinZhihao-723

Approved on behave of the code owner. Didn't check the content as @sitaowang1998 should have already reviewed.

Update github CI

da741bd

Bill-hbrhbr requested review from a team and sitaowang1998 as code owners April 4, 2026 17:23

coderabbitai bot reviewed Apr 4, 2026

View reviewed changes

Comment thread .github/actions/repo-checkout/action.yaml Outdated

Bill-hbrhbr added 3 commits April 4, 2026 13:30

Fix repo checkout action issue

bd2c7f5

Fix docs task paths

19ef8bb

Extract python setup action

401254c

Bill-hbrhbr changed the title ~~feat(ci): Add docs build CI.~~ feat(ci): Add coverage for building docs; Fix task paths in taskfiles/docs.yaml. Apr 4, 2026

Bill-hbrhbr changed the title ~~feat(ci): Add coverage for building docs; Fix task paths in taskfiles/docs.yaml.~~ feat(ci): Add coverage for building docs; Bump checkout to v6.0.2 and setup-python to v6.2.0; Fix task paths in taskfiles/docs.yaml. Apr 4, 2026

Bill-hbrhbr added 3 commits April 4, 2026 14:28

Move actions to ysocpe-dev-utils

d029e38

Use log tool version action

3178d75

Add install uv action

4147b4e

Bill-hbrhbr mentioned this pull request Apr 4, 2026

feat(ci): Add reusable GitHub actions for CI setup; Bump actions/checkout to v6.0.2. y-scope/yscope-dev-utils#110

Merged

4 tasks

Bill-hbrhbr added 4 commits April 4, 2026 15:14

Migrate setup java

cc2d9f2

Merge branch 'main' into add-docs-ci

1aff49c

Update dev utils branch

dcc53d4

rename log tool version action

daeb82e

coderabbitai bot reviewed Apr 9, 2026

View reviewed changes

sitaowang1998 previously approved these changes Apr 9, 2026

View reviewed changes

Docs minor update

3780848

Bill-hbrhbr dismissed sitaowang1998’s stale review via 3780848 April 9, 2026 16:17

sitaowang1998 requested a review from LinZhihao-723 April 9, 2026 17:13

LinZhihao-723 approved these changes Apr 9, 2026

View reviewed changes

sitaowang1998 merged commit 0d70a37 into y-scope:main Apr 10, 2026
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ci): Bump yscope-dev-utils to y-scope/yscope-dev-utils@38bf51e; Add coverage for building docs; Bump `actions/checkout` to v6.0.2; Fix task paths in `taskfiles/docs.yaml`.#298

feat(ci): Bump yscope-dev-utils to y-scope/yscope-dev-utils@38bf51e; Add coverage for building docs; Bump `actions/checkout` to v6.0.2; Fix task paths in `taskfiles/docs.yaml`.#298
sitaowang1998 merged 12 commits intoy-scope:mainfrom
Bill-hbrhbr:add-docs-ci

Bill-hbrhbr commented Apr 4, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 4, 2026 •

edited

Loading

Reviews paused

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

LinZhihao-723 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Bill-hbrhbr commented Apr 4, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Validation performed

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

LinZhihao-723 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Bill-hbrhbr commented Apr 4, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 4, 2026 •

edited

Loading