Skip to content

feat: sync the readme-weaver workflow to subscribed repositories - #2

Merged
shmileee merged 1 commit into
mainfrom
feat/sync-readme-weaver-workflow
Nov 15, 2026
Merged

shmileee merged 1 commit into
mainfrom
feat/sync-readme-weaver-workflow

Conversation

@shmileee

Copy link
Copy Markdown
Contributor

Description

Distributes the readme-weaver caller workflow with files-sync instead of copying it into each repository by hand.

  • .github/files-sync/workflows/readme-weaver.yaml is the canonical caller of devops-roast/github-actions/.github/workflows/readme-weaver.yaml@main. It lives outside .github/workflows so it does not run here: this repository keeps its own README up to date through the readme-weaver pre-commit hook.
  • A new files-sync pattern copies it to .github/workflows/readme-weaver.yaml in subscribed repositories. Subscribing = add the md:include markers to the README (paths relative to common-markdown/, e.g. path="sponsorship.md") and add the repository to the list.
  • First subscriber: devops-roast/pre-commit-hooks. The file is byte-identical to the one in chore: add readme-weaver workflow pre-commit-hooks#8, so if that PR is merged first the sync produces no diff there.

Merge order

  1. fix: make woven output formatter-stable and skip fenced examples readme-weaver#6 → release v0.1.2
  2. fix: authenticate mise against the GitHub API in pre-commit github-actions#14 and #13 (bumped to readme-weaver v0.1.2)
  3. chore: add readme-weaver workflow pre-commit-hooks#8
  4. this PR

Definition of Done

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

Keep the readme-weaver caller workflow here and distribute it with
files-sync to the repositories that embed common-markdown partials in
their README. It lives outside .github/workflows so it does not run in
this repository, which updates its own README through the readme-weaver
pre-commit hook. pre-commit-hooks is the first subscriber.
@shmileee
shmileee merged commit 24b982e into main Nov 15, 2026
@shmileee
shmileee deleted the feat/sync-readme-weaver-workflow branch November 15, 2026 19:48
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