fix(doc-gardening): remove git operations from lint path - #2342
Draft
felladrin wants to merge 4 commits into
Draft
fix(doc-gardening): remove git operations from lint path#2342felladrin wants to merge 4 commits into
felladrin wants to merge 4 commits into
Conversation
| function runGarden(args = [], cwd = __dirname) { | ||
| const cmd = `node ${SCRIPT_PATH} ${args.join(" ")}`; | ||
| try { | ||
| const output = execSync(cmd, { cwd, encoding: "utf8", stdio: "pipe" }); |
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.
Problem
npm run lintrunsscripts/doc-gardening.cjs, which unconditionally callscreateFixupPRs(). That function:git checkout -b doc-gardening-<timestamp>— switches your branch, carrying your working tree onto a new branch.applyFix— rewrites offending docs, replacing broken links with[REMOVED BROKEN LINK].git add .— stages everything in the tree, including unrelated work.git commit -m "docs: fix documentation issues found by doc gardening"— commits it all.Despite the name, it never opens a PR; it prints the
git pushandgh pr createcommands for you to run manually.Solution
garden()no longer callscreateFixupPRs()unconditionally.--fixflag.--fixalso requires a clean working tree (checked viagit status --porcelain) so it can never sweep unrelated changes into a commit.Acceptance criteria
npm run lintnever runsgit checkout,git addorgit commit.docs/fails lint with a message naming the file and the target.