fix(docs): remove stale docs/DEPLOYMENT.md duplicate - #1947
Merged
efiten merged 1 commit intoSep 3, 2026
Conversation
…nt.md Two files tracked in git, docs/DEPLOYMENT.md and docs/deployment.md, collide into one file on case-insensitive filesystems (default on macOS/Windows), making git status report spurious modifications. docs/deployment.md is the actively maintained, cross-referenced guide (linked from README.md and docs/deployment-behind-cdn.md); DEPLOYMENT.md was an untouched leftover from before the MeshCore -> CoreScope rename. Constraint: keep the lowercase path since it is the one referenced elsewhere in the repo Confidence: high Scope-risk: narrow
efiten
added a commit
that referenced
this pull request
Sep 3, 2026
Two documentation-only PRs were running the full pipeline simultaneously this afternoon: #1948 (`CHANGELOG.md` plus a release note) and #1947 (deleting a stale `docs/DEPLOYMENT.md`). Each spends about 12 minutes on Go Build & Test and about 16 minutes on Playwright to establish that a text file does not break a browser. **The cost is the queue, not the minutes.** On the same afternoon a `pull_request` run was created at 12:13 and its first job did not start until 16:19. Four hours in the queue. Every unnecessary run pushes the ones that matter further back, and this repository has been merging heavily today. ## Checked before adding the filter Rather than assumed: - **Nothing reads markdown at build or test time.** Grepping every Go and JS source for a runtime read (`ReadFile`, `readFileSync`, `os.Open`) of a `.md` path returns nothing. The `docs/` matches in `cmd/` and `test-*.js` are all comments pointing at documentation. - `/api/docs` serves Swagger UI generated from `cmd/server/openapi.go`, not from `docs/`. - `docs/` holds markdown plus screenshots (`png`, `gif`) and no build input. - **This workflow has no tag trigger**, so release tagging is unaffected; that runs from `release-fast-path.yml`. Worth stating explicitly given a `v3.10.0` tag is imminent. `paths-ignore` skips only when **every** changed file matches, so a PR touching both code and documentation still runs the full pipeline. ## The trap, stated in the file If required status checks are ever enabled on master, a skipped workflow never reports, and a docs-only PR would wait forever on a check that cannot arrive. At that point this needs to become a change-detection job with conditional heavy jobs rather than a trigger filter. Master has no required checks today. Verified: the branch protection endpoint returns 404. That caveat is in a comment above the `on:` block, not just in this description, because the person who enables required checks in six months will be reading the workflow and not this PR. ## Note This PR itself changes only `.github/workflows/deploy.yml`, so it is not documentation-only and will run the full pipeline, as it should. Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
2 participants
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
docs/DEPLOYMENT.mdanddocs/deployment.mdwere both tracked in git, colliding into a single file on case-insensitive filesystems (default on macOS/Windows) and causinggit statusto report spurious modifications.docs/deployment.mdis the actively maintained guide (linked fromREADME.mdanddocs/deployment-behind-cdn.md);docs/DEPLOYMENT.mdwas a stale duplicate untouched since the MeshCore → CoreScope rename.docs/DEPLOYMENT.mdfrom the index, keepingdocs/deployment.md.Test plan
git statusis clean on a case-insensitive checkout with no spurious modificationdocs/DEPLOYMENT.mdin the repo