Skip to content

chore: consolidate docs update#6908

Merged
LesnyRumcajs merged 1 commit intomainfrom
consolidate-docs-update
Apr 15, 2026
Merged

chore: consolidate docs update#6908
LesnyRumcajs merged 1 commit intomainfrom
consolidate-docs-update

Conversation

@LesnyRumcajs
Copy link
Copy Markdown
Member

@LesnyRumcajs LesnyRumcajs commented Apr 15, 2026

Summary of changes

Changes introduced in this pull request:

  • similar enough to live in the same workflow

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Outside contributions

  • I have read and agree to the CONTRIBUTING document.
  • I have read and agree to the AI Policy document. I understand that failure to comply with the guidelines will lead to rejection of the pull request.

Summary by CodeRabbit

  • Chores
    • Consolidated documentation generation workflows to streamline automated updates for both CLI and RPC reference documentation, improving maintainability and ensuring consistent documentation delivery across all components.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 15, 2026

Walkthrough

Consolidated OpenRPC specification generation workflow by integrating the separate docs-rpc-auto-update.yml job into docs-auto-update.yml. The main workflow now handles both CLI and RPC documentation updates, while the redundant dedicated workflow file is removed.

Changes

Cohort / File(s) Summary
Workflow consolidation
.github/workflows/docs-auto-update.yml
Renamed workflow to "Update Forest docs". Renamed update-docs job to update-cli-docs. Added new update-rpc-docs job that runs OpenRPC specification generation, generates GitHub App token, and creates a separate PR targeting leshy/update-forest-rpc-docs branch with restricted changes to docs/openrpc-specs/.
Removed workflow file
.github/workflows/docs-rpc-auto-update.yml
Deleted entire dedicated RPC documentation workflow file previously containing scheduled daily and manual triggers for OpenRPC specification regeneration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • hanabi1224
  • sudo-shashank
🚥 Pre-merge checks | ✅ 3
✅ 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 'chore: consolidate docs update' accurately reflects the main change: merging the separate RPC docs workflow into the main docs workflow, consolidating two related documentation update processes into one.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch consolidate-docs-update
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch consolidate-docs-update

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
.github/workflows/docs-auto-update.yml (1)

7-12: Add workflow-level concurrency to prevent fixed-branch PR races.

Because both jobs push to fixed branches (Line 33, Line 60), overlapping runs (e.g., schedule + manual dispatch) can cause noisy branch-update conflicts. A workflow-level concurrency guard improves reliability.

♻️ Suggested hardening
 on:
   workflow_dispatch:
   schedule:
     - cron: "0 0 * * *"
+
+concurrency:
+  group: docs-auto-update
+  cancel-in-progress: false

Also applies to: 33-33, 60-60

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/docs-auto-update.yml around lines 7 - 12, Add a
workflow-level concurrency stanza to the top of the YAML to prevent overlapping
runs from racing when the jobs push to fixed branches; specifically add a
top-level concurrency block (e.g., group: a stable identifier combining the
workflow and ref such as "docs-auto-update-${{ github.ref }}" and
cancel-in-progress: true) so scheduled and manual dispatches cannot run
concurrently and cause branch-update conflicts between the jobs that push to the
fixed branches.
🤖 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/docs-auto-update.yml:
- Around line 7-12: Add a workflow-level concurrency stanza to the top of the
YAML to prevent overlapping runs from racing when the jobs push to fixed
branches; specifically add a top-level concurrency block (e.g., group: a stable
identifier combining the workflow and ref such as "docs-auto-update-${{
github.ref }}" and cancel-in-progress: true) so scheduled and manual dispatches
cannot run concurrently and cause branch-update conflicts between the jobs that
push to the fixed branches.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 5951f6e7-e727-4d66-b3ee-ed3e2f8d3893

📥 Commits

Reviewing files that changed from the base of the PR and between 227b6e5 and 246ce52.

📒 Files selected for processing (2)
  • .github/workflows/docs-auto-update.yml
  • .github/workflows/docs-rpc-auto-update.yml
💤 Files with no reviewable changes (1)
  • .github/workflows/docs-rpc-auto-update.yml

@LesnyRumcajs LesnyRumcajs enabled auto-merge April 15, 2026 08:24
@LesnyRumcajs LesnyRumcajs added this pull request to the merge queue Apr 15, 2026
Merged via the queue into main with commit b0c607b Apr 15, 2026
23 checks passed
@LesnyRumcajs LesnyRumcajs deleted the consolidate-docs-update branch April 15, 2026 09:01
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.

2 participants