Skip to content

fix(docs): trigger workflow on README.md changes to keep llms.txt current#1332

Open
joshuadarron wants to merge 1 commit into
developfrom
fix/RR-1331-docs-trigger-readme-md
Open

fix(docs): trigger workflow on README.md changes to keep llms.txt current#1332
joshuadarron wants to merge 1 commit into
developfrom
fix/RR-1331-docs-trigger-readme-md

Conversation

@joshuadarron

@joshuadarron joshuadarron commented Jun 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Replaces the stale nodes/src/nodes/**/doc.md path trigger in docs.yml with nodes/src/nodes/**/README.md — matching what gather.js actually reads.

Problem

gather.js uses NODES_GLOB = 'nodes/src/nodes/*/README.md' (and variant sub-pages at nodes/src/nodes/*/*/README.md) as its source for all node documentation. The doc.md entry in the workflow paths filter never matched any real file, so node doc changes never triggered a docs rebuild — leaving llms.txt and llms-full.txt out of date on the deployed site.

Test plan

  • Merge a change that only edits a node README.md (e.g. nodes/src/nodes/webhook/README.md) and confirm the Docs workflow fires.
  • After deploy, verify llms-full.txt reflects the updated content.

Closes #1331

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Updated the automated documentation build workflow to improve inclusion of node-specific documentation files in the build process.

…rent

gather.js reads node docs from nodes/src/nodes/*/README.md, not doc.md.
The stale doc.md path filter meant node doc changes never triggered a
rebuild, leaving llms.txt and llms-full.txt stale on the deployed site.

Closes #1331

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@joshuadarron joshuadarron requested a review from kwit75 as a code owner June 20, 2026 19:26
@github-actions github-actions Bot added the ci/cd CI/CD and build system label Jun 20, 2026
@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5fa7c989-6b2e-496e-9910-9db7d33061cb

📥 Commits

Reviewing files that changed from the base of the PR and between e1b4da7 and 1b73a85.

📒 Files selected for processing (1)
  • .github/workflows/docs.yml

📝 Walkthrough

Walkthrough

The docs GitHub Actions workflow trigger path filter is updated by replacing the glob nodes/src/nodes/**/doc.md with nodes/src/nodes/**/README.md, aligning the trigger with the actual filename used by node documentation files. No other workflow logic is changed.

Changes

Docs Workflow Path Filter

Layer / File(s) Summary
Workflow push path trigger
.github/workflows/docs.yml
The on.push.paths entry for node documentation is changed from nodes/src/nodes/**/doc.md to nodes/src/nodes/**/README.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A bunny hopped through paths one day,
And found doc.md led astray.
"README's the name!" the rabbit cried,
Swapped the glob with one small stride. 🐇
Now docs deploy when READMEs change — hooray!

🚥 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 The title accurately describes the main change: updating the docs workflow trigger from doc.md to README.md to keep llms.txt current.
Linked Issues check ✅ Passed The code changes fully implement the objective from issue #1331: replacing the stale doc.md path filter with README.md to trigger documentation regeneration.
Out of Scope Changes check ✅ Passed The pull request contains only the necessary change to fix the workflow trigger; no unrelated modifications or out-of-scope alterations are present.
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 fix/RR-1331-docs-trigger-readme-md

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.

@github-actions

Copy link
Copy Markdown
🤖 Internal: Discord sync marker

Auto-managed by the Discord notification workflow. Stores the linked Discord message ID. Do not edit or delete.

@joshuadarron joshuadarron self-assigned this Jun 20, 2026
@joshuadarron joshuadarron enabled auto-merge (squash) June 20, 2026 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci/cd CI/CD and build system

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix(docs): trigger docs workflow on README.md changes to regenerate llms.txt

1 participant