chore: ignore local JDK-docs corpus in docs/ (#22) - #29
Open
devops-thiago wants to merge 1 commit into
Open
Conversation
The docs/ directory holds a ~326 MB JDK 25 HTML documentation bundle provisioned locally (lab VM / Docker volume mount). It was untracked but not ignored, so a stray `git add -A` could commit it and permanently bloat the repository. Ignore docs/* while keeping docs/README.md tracked, and document how to obtain the corpus.
🤖 ThrillhouseBot PR SummaryWhat this PR doesAdds a gitignore rule for the locally provisioned JDK 25 documentation corpus, re-includes docs/README.md so it remains tracked, and documents where the corpus comes from and how to ingest it. Changes Overview
Changed Files
Risk Assessment
No new issues found in this PR, but the review cannot be approved until CI is confirmed green.
|
| Check | Type | Status | Detail |
|---|---|---|---|
| Build & Test | check-run | ⏳ Pending | - |
Automated review by ThrillhouseBot. Reply with /review to re-run.
thrillhousebot
Bot
added
the
documentation
|
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
docs/*to.gitignoreso the ~326 MB local JDK 25 documentation corpus can never be accidentally committed by a straygit add -A.docs/README.mdtracked (via!docs/README.md) to document what the directory is and how to obtain the corpus../docs:/app/docs:roindocker-compose.yml).Issue
Fixes #22
Test plan
git check-ignore docs/reports the directory as ignoredgit add -Ano longer stagesdocs/(dry-run shows only.gitignore,docs/README.md, and the pre-existing untrackeddocker-compose.e2e.yml— tracked separately in Resolve untracked docker-compose.e2e.yml leftover artifact #25)docs/README.mddocuments where the corpus comes from and how to ingest it