docs+ci: drop START.bat reference, skip build on docs-only pushes#47
Merged
Conversation
START.bat was removed from the repo entirely back in PR #36 (the release-ZIP trim) but the README's Portable column still told users to "click START.bat". Updated to "Double-click WRAITH.exe", which is how the actual portable flow works. Also clarified that the Headless quick scan section (quick-scan.ps1) applies to source builds only — quick-scan.ps1 isn't in the release ZIP either, so binary-install users were getting "command not found" when they tried to follow that section.
There was a problem hiding this comment.
Pull request overview
Updates the README to reflect the current release ZIP contents after launcher/helper scripts were removed from the portable distribution, so users don’t follow instructions that lead to missing files.
Changes:
- Updates the Portable install “Launcher” instruction to run
WRAITH.exedirectly (instead ofSTART.bat). - Relabels the headless quick scan section to indicate
quick-scan.ps1is only available from a source checkout (not in the release ZIP), and adds a short note to clone the repo first.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+178
to
+180
| ### Headless quick scan (source build only) | ||
| The `quick-scan.ps1` helper ships with the source tree, not the release | ||
| ZIP. Clone the repo first, then: |
Comment on lines
+178
to
+180
| ### Headless quick scan (source build only) | ||
| The `quick-scan.ps1` helper ships with the source tree, not the release | ||
| ZIP. Clone the repo first, then: |
Adds paths-ignore so commits that only touch markdown, docs/, or LICENSE don't kick off a Windows runner, don't bump the patch tag, and don't publish a new release for what is by definition a no-op for users on the binary. Tag-push trigger is unchanged — `git tag vX.Y.Z && git push origin vX.Y.Z` still cuts a release regardless of which files changed in the underlying commit, so backports and explicit hotfixes are unaffected. Patterns: - **.md README, CHANGELOG, CONTRIBUTING, any markdown anywhere - docs/** the docs tree - LICENSE license tweaks (rare) shouldn't ship a "new" version Things that DO still trigger: - VERSION (controls the patch derivation) - Anything in WRAITH/, scanner/, automation/, WRAITH.Tests/, .github/
Comment on lines
+178
to
+180
| ### Headless quick scan (source build only) | ||
| The `quick-scan.ps1` helper ships with the source tree, not the release | ||
| ZIP. Clone the repo first, then: |
Comment on lines
+35
to
+37
| paths-ignore: | ||
| - '**.md' | ||
| - 'docs/**' |
Comment on lines
+30
to
+34
| # Doc-only commits don't change anything that ships — skip the build, | ||
| # save the runner minutes, and keep the patch number from ticking up | ||
| # for a README typo fix. The tags trigger below is intentionally | ||
| # unrestricted: an explicit `git tag vX.Y.Z && git push` should | ||
| # always cut a release regardless of which files changed. |
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.
Summary
Two doc-related cleanups bundled together since they share a theme: doc-only changes shouldn't masquerade as releasable code.
1.
START.batis gone from the READMEPR #36 removed
START.batfrom the repo entirely but the README's Portable install row still told users to "click START.bat". Updated to "Double-clickWRAITH.exe", which is how the actual portable flow works now.Also relabelled the Headless quick scan section as "source build only" —
quick-scan.ps1lives in the source tree but isn't in the release ZIP, so binary-install users following those instructions hit "command not found".2. Doc-only main pushes don't cut a release anymore
Added
paths-ignoreto the workflow'spushtrigger so commits that only touch markdown,docs/, orLICENSEdon't:Unchanged: the tag-push trigger has no
paths-ignore. An explicitgit tag vX.Y.Z && git push origin vX.Y.Zstill cuts a release regardless of which files changed — backports and explicit hotfixes are unaffected.Things that still trigger a build:
VERSION(controls patch derivation), and anything underWRAITH/,scanner/,automation/,WRAITH.Tests/, or.github/.Test plan
paths-ignore, so we'll get one final build for the change-that-introduces-the-skip. Subsequent doc-only commits won't.)VERSIONbump or any code change → Deploy still runs.