fix: wire sync-contributing into build pipeline (closes #246)#474
Open
frameworks-volunteer wants to merge 2 commits intosecurity-alliance:developfrom
Open
Conversation
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
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
1 participant
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.
Summary
Wires the existing
utils/sync-contributing.jsscript into the build pipeline so thatCONTRIBUTING.mdat the repo root is automatically generated fromdocs/pages/contribute/contributing.mdxon every build/dev start. This eliminates the need to manually keep both files in sync.Changes
sync-contributingscript and prepended it todocs:devanddocs:buildso the sync runs before every build and dev server start.syncrecipe for manual invocation (just sync), and cleaned up trailing whitespace on theserverecipe..mdxsource via the sync script. Minor formatting differences reflect the automated transformation (line wraps, whitespace) -- content is unchanged.How it works
The
sync-contributing.jsscript readscontributing.mdx, strips MDX-specific elements (frontmatter, JSX comments, imports, components), converts internal links and Mermaid components to plain markdown, and writes the result to the rootCONTRIBUTING.mdwith an auto-generated header warning not to edit it directly.Closes #246