Skip to content

docs(auto-derive): document cross-repo dispatch trigger + fix dead G6 link#144

Merged
bradymiller merged 2 commits into
openemr:masterfrom
bradymiller:readme-update-cross-repo-dispatch
Jun 28, 2026
Merged

docs(auto-derive): document cross-repo dispatch trigger + fix dead G6 link#144
bradymiller merged 2 commits into
openemr:masterfrom
bradymiller:readme-update-cross-repo-dispatch

Conversation

@bradymiller

@bradymiller bradymiller commented Jun 28, 2026

Copy link
Copy Markdown
Member

Summary

Two README updates following the G6 work that landed:

  1. Fix dead `G6 matrix` link. Original rabbit comment from PR feat(auto-derive): scaffold ip_map + demoLibrary derivation bot (dry-run) #135 review (id=3485751948) flagged this; the addressed-in-commit fix targeted README:6 but missed this second occurrence at README:19. Replaced with prose since the matrix lives in the design doc linked above, not anywhere in this repo.

  2. Document the cross-repo dispatch trigger. PR feat(auto-derive): atomic flip — retire bump-tag.yml + tools/release/ PHP toolchain #141 added the `repository_dispatch: types: [release-targets-changed]` listener; feat(release): add release-targets-changed dispatch event + workflow openemr#12657 added the openemr-side dispatcher that fires it on push to `.github/release-targets.yml`. README's "Daily reconcile + auto-PR" section is rewritten as "Triggers + reconcile + auto-PR" — enumerates all 3 fire triggers (daily cron, release-targets-changed dispatch, manual workflow_dispatch) with the existing reconciliation behavior under a unified "in all three trigger paths" framing.

Test plan

  • CI passes (workflow lint)
  • README renders correctly on GitHub

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated section ownership guidance to link to the external design reference.
    • Reorganized reconcile documentation into a single “Triggers + reconcile + auto-PR” section covering scheduled, event-based, and manual entrypoints.
    • Clarified trigger behavior, including how dry-run differs and what it uploads, plus the reconcile flow for diff detection and no-diff outcomes.
    • Reiterated the limitation that bot-created pull requests won’t automatically trigger downstream workflows, and noted how to re-run CI manually.

… link

Two updates:

* Fix the dead `[G6 matrix](#)` empty-anchor link (rabbit had
  flagged in openemr#135 review; the original fix targeted README:6 not
  README:19; replaced with prose since the matrix is in the design
  doc linked above, not anywhere in this repo).
* Rewrite the "Daily reconcile + auto-PR" section as "Triggers +
  reconcile + auto-PR" — enumerates all 3 fire triggers (daily cron,
  release-targets-changed repository_dispatch added by openemr#12657,
  manual workflow_dispatch). Existing reconciliation behavior moved
  under the "in all three trigger paths" framing. Trimmed the
  redundant workflow_dispatch paragraph that now duplicates the
  trigger enumeration.
@coderabbitai

coderabbitai Bot commented Jun 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 6a563e1c-d7d3-48f4-8e9f-d2e8d09eb6c7

📥 Commits

Reviewing files that changed from the base of the PR and between 8e1f83f and e5845e9.

📒 Files selected for processing (1)
  • tools/auto-derive/README.md
✅ Files skipped from review due to trivial changes (1)
  • tools/auto-derive/README.md

📝 Walkthrough

Walkthrough

Updates tools/auto-derive/README.md to point the section ownership reference at the G6 design doc, replace the daily reconcile section with three trigger paths, and keep the GITHUB_TOKEN caveat plus manual CI re-trigger command.

Changes

README documentation update

Layer / File(s) Summary
Section ownership and reconcile docs
tools/auto-derive/README.md
Updates the G6 reference link, lists the daily cron, repository_dispatch, and workflow_dispatch reconcile entrypoints, describes reconcile versus dry-run behavior, and preserves the bot PR caveat and empty-commit CI instruction.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • openemr/demo_farm_openemr#138: Adds the reconcile workflow behavior that this README update documents, including trigger paths and PR update handling.

Poem

🐇 I nibbled the README, neat and bright,
Three triggers now hop in clear daylight.
A G6 doc glows where anchors once slept,
And CI gets a nudge when an empty commit’s kept.

🚥 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 summarizes the README docs update: the new cross-repo dispatch trigger and the dead G6 link fix.
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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

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 `@tools/auto-derive/README.md`:
- Around line 145-149: The README wording for the workflow trigger section
conflates dry-run with the reconcile path, since `workflow_dispatch` can select
`dry-run` and that mode does not create or update a PR. Update the section
around the `workflow_dispatch` description and the “reconcile job” wording to
explicitly scope the behavior to reconcile mode, or split out a separate dry-run
description so the `reconcile` and `dry-run` paths are clearly distinguished.
🪄 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a257de96-f5f5-459a-b81a-fe7a3eb49607

📥 Commits

Reviewing files that changed from the base of the PR and between bce5c3b and 8e1f83f.

📒 Files selected for processing (1)
  • tools/auto-derive/README.md

Comment thread tools/auto-derive/README.md Outdated
@bradymiller
bradymiller merged commit a05cc6e into openemr:master Jun 28, 2026
4 checks passed
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