fix: trigger docs build after changelog update

[koxudaxi]

Summary by CodeRabbit

• Chores
  • Enhanced documentation workflow automation to trigger automatically when related workflows complete, improving consistency of documentation updates alongside code changes.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Warning

Rate limit exceeded

@koxudaxi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 5 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ed2b100 and 228e994.

📒 Files selected for processing (1)

• .github/workflows/docs.yaml (1 hunks)

Walkthrough

A GitHub Actions workflow trigger is added to the Docs workflow, enabling it to run automatically when the Update CHANGELOG workflow completes, supplementing the existing push and workflow_dispatch triggers.

Changes

Cohort / File(s)	Summary
Workflow Trigger Configuration ​.github/workflows/docs.yaml	Added workflow_run trigger with type: completed for the Update CHANGELOG workflow, enabling the Docs workflow to execute upon successful completion of the changelog update process

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single file modification with minimal, straightforward configuration addition
• No logic changes, no behavioral complexity
• Workflow trigger syntax is standard and predictable

Possibly related PRs

• docs: Add CHANGELOG.md with auto-update workflow #2690: Directly related—adds the workflow_run trigger so the docs workflow runs when the Update CHANGELOG workflow completes successfully.

Poem

🐰 A trigger springs to life, so fine,
When CHANGELOG completes its design,
Docs workflow hops without delay,
Automation brightens up the day! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: adding a workflow trigger to run the docs build after a changelog update, which aligns with the workflow modification shown in the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fba4713 and ed2b100.

📒 Files selected for processing (1)

• .github/workflows/docs.yaml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)

• GitHub Check: py312-isort5 on Ubuntu
• GitHub Check: 3.10 on Windows
• GitHub Check: py312-pydantic1 on Ubuntu
• GitHub Check: 3.11 on Ubuntu
• GitHub Check: 3.12 on Windows
• GitHub Check: 3.11 on Windows
• GitHub Check: 3.13 on Windows
• GitHub Check: 3.14 on Windows
• GitHub Check: Analyze (python)
• GitHub Check: benchmarks

🔇 Additional comments (1)

.github/workflows/docs.yaml (1)

21-21: The checkout action behavior is correct as-is. The "Update CHANGELOG" workflow is triggered by releases and explicitly checks out the main branch (with ref: main), meaning CHANGELOG.md updates always occur on main. When the docs workflow's workflow_run trigger activates, actions/checkout@v4 defaults to the repository's default branch (main), which is exactly where the updated CHANGELOG.md exists. No ref override is necessary.

Likely an incorrect or invalid review comment.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.34%. Comparing base (fba4713) to head (228e994).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2710   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files          81       81           
  Lines       11535    11535           
  Branches     1387     1387           
=======================================
  Hits        11459    11459           
  Misses         45       45           
  Partials       31       31           

Flag	Coverage Δ
unittests	99.34% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

[codspeed-hq]

CodSpeed Performance Report

Merging #2710 will not alter performance

_{Comparing fix/trigger-docs-after-changelog (228e994) with main (fba4713)}

Summary

✅ 52 untouched
⏩ 10 skipped¹

Footnotes

1. 10 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩