Skip to content

feat: add readme-weaver-distribute workflow - #15

Closed
shmileee wants to merge 1 commit into
mainfrom
feat/readme-weaver-distribute
Closed

shmileee wants to merge 1 commit into
mainfrom
feat/readme-weaver-distribute

Conversation

@shmileee

Copy link
Copy Markdown
Contributor

Description

Today a change to a partial in devops-roast/.github/common-markdown (e.g. sponsorship.md) only reaches a subscriber the next time that repository gets a pull request. This adds a reusable workflow that devops-roast/.github runs when a partial changes:

  1. subscribers: reads the files-sync configuration and takes every repository of a pattern that syncs .github/workflows/readme-weaver.yaml. One list, so subscribing a repository to the workflow also subscribes it to distribution.
  2. distribute (matrix, one job per subscriber): checks the subscriber out with the bot token, weaves the partials at partials_ref exactly like the readme-weaver workflow (hidden .readme-weaver-partials + .git/info/exclude, readme-weaver v0.1.2), and runs peter-evans/create-pull-request (v8.1.1, signed bot commits) on readme-weaver/sync-partials. No README change = no pull request; a later partial change updates the open one; a now-empty one is closed.
  3. Enables auto-merge (squash). Like the files-sync pull requests, the PR is labelled auto-sync, requests a review from reviewers (default shmileee) and merges once approved and green.

The README change is in the pull request from its first commit, so auto-merge cannot race a follow-up commit (which a files-sync-only approach would have: readme-weaver is not a required check).

Tested end to end from devops-roast/.github (see the linked PR there).

Definition of Done

  • The change is thoroughly documented.
  • The CI passes (linter, unit tests, spelling, etc.).
  • Any generated files have been updated.

Weave the common markdown partials into every readme-weaver subscriber
and open (or update) a pull request where the README changes, so a
partial change reaches subscribers without waiting for their next pull
request. Subscribers are read from the files-sync configuration: every
repository that gets the readme-weaver workflow synced. The pull request
is labelled auto-sync, requests a review and merges automatically once
approved and green, like the files-sync pull requests.
@shmileee

Copy link
Copy Markdown
Contributor Author

Closing: we decided not to push partial changes to subscribers automatically. Subscribed READMEs keep refreshing through the per-PR readme-weaver workflow.

@shmileee shmileee closed this Nov 15, 2026
@shmileee
shmileee deleted the feat/readme-weaver-distribute branch November 15, 2026 20:13
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