Repository navigation
Conversation
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.
2 of 3 tasks
Contributor
Author
|
Closing: we decided not to push partial changes to subscribers automatically. Subscribed READMEs keep refreshing through the per-PR readme-weaver workflow. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:.github/workflows/readme-weaver.yaml. One list, so subscribing a repository to the workflow also subscribes it to distribution.partials_refexactly like the readme-weaver workflow (hidden.readme-weaver-partials+.git/info/exclude, readme-weaver v0.1.2), and runspeter-evans/create-pull-request(v8.1.1, signed bot commits) onreadme-weaver/sync-partials. No README change = no pull request; a later partial change updates the open one; a now-empty one is closed.auto-sync, requests a review fromreviewers(defaultshmileee) 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