OSAC-1407: Whitelist committed overlays in .gitignore - #258
tchughesiv wants to merge 1 commit into
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: osac-project/coderabbit/.coderabbit.yaml Review profile: ASSERTIVE Plan: Enterprise Run ID: 📒 Files selected for processing (2)
WalkthroughThis PR updates ChangesOverlay Directory Git Tracking
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 11✅ Passed checks (11 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
tchughesiv
changed the title
tchughesiv
changed the title
tchughesiv
changed the title
f2ae1ae to
04c87a2
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
tchughesiv
changed the title
|
@tchughesiv: This pull request references OSAC-1407 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
tchughesiv
changed the title
tchughesiv
changed the title
tchughesiv
changed the title
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 195: The README.md file has markdown linting violations (MD031) where
fenced code blocks are missing required blank lines. Add a blank line
immediately before each opening triple backticks (```yaml and other code block
markers) and immediately after each closing triple backticks on lines 195, 207,
218, 227, and 245. Ensure there is whitespace separating the code blocks from
surrounding text to comply with markdown formatting standards.
- Around line 190-192: The README.md file contains multiple instances of "bare
metal" that are used as compound adjectives modifying following nouns and should
be hyphenated as "bare-metal" for grammatical correctness. Search for all
occurrences of "bare metal" in the file and replace those that function as
compound adjectives (such as in phrases like "bare-metal fulfillment",
"bare-metal provider", "bare-metal management", and "bare-metal host") with the
hyphenated form "bare-metal". Ensure consistent application across all locations
where this compound adjective appears, while noting that proper nouns like "Bare
Metal Fulfillment Operator" may be exempt from this rule.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: osac-project/coderabbit/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 848e63b2-a458-4625-a7a0-b92a44fed17d
📒 Files selected for processing (1)
README.md
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's internal server error or limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 195: The README.md file has markdown linting violations (MD031) where
fenced code blocks are missing required blank lines. Add a blank line
immediately before each opening triple backticks (```yaml and other code block
markers) and immediately after each closing triple backticks on lines 195, 207,
218, 227, and 245. Ensure there is whitespace separating the code blocks from
surrounding text to comply with markdown formatting standards.
- Around line 190-192: The README.md file contains multiple instances of "bare
metal" that are used as compound adjectives modifying following nouns and should
be hyphenated as "bare-metal" for grammatical correctness. Search for all
occurrences of "bare metal" in the file and replace those that function as
compound adjectives (such as in phrases like "bare-metal fulfillment",
"bare-metal provider", "bare-metal management", and "bare-metal host") with the
hyphenated form "bare-metal". Ensure consistent application across all locations
where this compound adjective appears, while noting that proper nouns like "Bare
Metal Fulfillment Operator" may be exempt from this rule.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: osac-project/coderabbit/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Enterprise
Run ID: 848e63b2-a458-4625-a7a0-b92a44fed17d
📒 Files selected for processing (1)
README.md
🛑 Comments failed to post (2)
README.md (2)
190-192: 🧹 Nitpick | 🔵 Trivial | 💤 Low value
Use hyphens for "bare-metal" when used as a compound adjective.
LanguageTool flagged several instances where "bare metal" is used as a compound adjective modifying a following noun. When used in this context, it should be hyphenated as "bare-metal" for grammatical correctness:
- Line 190: "For bare-metal fulfillment, copy each..."
- Line 194: "OpenStack credentials for the bare-metal provider:"
- Line 206: "inventory source configuration for bare-metal management:" (if added)
- Line 217: "management cloud configuration for bare-metal environments:" (if added)
- Line 226: "one entry per bare-metal host provisioning profile:"
Note: "Bare Metal Fulfillment Operator" as a proper noun may be exempt, but compound adjectives should consistently use hyphens.
Also applies to: 194-194, 206-206, 217-217, 226-226, 242-249
🧰 Tools
🪛 LanguageTool
[uncategorized] ~190-~190: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ally. - Inkustomization.yaml: For bare metal fulfillment, copy each.examplefile ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 190 - 192, The README.md file contains multiple instances of "bare metal" that are used as compound adjectives modifying following nouns and should be hyphenated as "bare-metal" for grammatical correctness. Search for all occurrences of "bare metal" in the file and replace those that function as compound adjectives (such as in phrases like "bare-metal fulfillment", "bare-metal provider", "bare-metal management", and "bare-metal host") with the hyphenated form "bare-metal". Ensure consistent application across all locations where this compound adjective appears, while noting that proper nouns like "Bare Metal Fulfillment Operator" may be exempt from this rule.Source: Linters/SAST tools
195-195: 🧹 Nitpick | 🔵 Trivial | 💤 Low value
Add blank lines before and after fenced code blocks (markdownlint MD031).
Markdown linting flagged missing blank lines around several code blocks. Add a blank line immediately before each opening triple backticks and immediately after each closing triple backticks for consistent formatting:
Some text above. [blank line here] ```yaml code here[blank line here]
Some text below.Affected lines: 195, 207, 218, 227, 245. Also applies to: 207-207, 218-218, 227-227, 245-245 <details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.22.1)</summary> [warning] 195-195: Fenced code blocks should be surrounded by blank lines (MD031, blanks-around-fences) </details> </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@README.mdat line 195, The README.md file has markdown linting violations
(MD031) where fenced code blocks are missing required blank lines. Add a blank
line immediately before each opening triple backticks (```yaml and other code
block markers) and immediately after each closing triple backticks on lines 195,
207, 218, 227, and 245. Ensure there is whitespace separating the code blocks
from surrounding text to comply with markdown formatting standards.</details> <!-- fingerprinting:phantom:triton:mongoose --> <!-- cr-comment:v1:8c6e8fbf9a1e768c2637a9bb --> _Source: Linters/SAST tools_ <!-- This is an auto-generated comment by CodeRabbit --> </blockquote></details> </blockquote></details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Response to CodeRabbit reviewThanks for the review. Both actionable items are on README sections that came in from the recent 1. "bare metal" → "bare-metal" hyphenation (lines 190–249) — Declining for this PR. Valid style nit, but out of scope for a gitignore whitelist change. Happy to address in a separate docs cleanup PR if the team wants consistency pass on the bare-metal section. 2. MD031 blank lines around fenced code blocks (lines 195, 207, 218, 227, 245) — Declining for this PR. Same reason: pre-existing formatting in merged README content, not introduced by this diff. A docs-only follow-up is a better home for markdownlint fixes across the whole file. No code changes needed from my side for these items. CI is green; remaining merge blockers are human review ( Side note: openshift-ci flagged OSAC-1407 missing target version |
|
@coderabbitai review |
✅ Action performedReview finished.
|
98b500f to
558a4af
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: tchughesiv The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
4530fd9 to
7fd99b1
Compare
Move overlay whitelist rules into the root .gitignore so ignore policy lives in one place. Personal overlays under overlays/<project-name> stay ignored; only committed overlay directories are tracked. Document the behavior in README using "committed" terminology from AGENTS.md. Assisted-by: Claude Code <noreply@anthropic.com>
7fd99b1 to
0afca98
Compare
|
Closing as obsolete after OSAC-1677 (#398) removed Kustomize from the installer.
If we still want to gitignore local legacy |
2 participants
Summary
.gitignoreso only committed overlay directories (_shared,development,caas-ci,vmaas-ci,osac-integration,hypershift2) are tracked. Any other path underoverlays/is ignored by default.overlays/<project-name>) are gitignored and won't appear ingit status.Personal overlays use any directory not on the whitelist (e.g.
overlays/tohughes-dev). To add a new committed overlay, update the whitelist entries in the root.gitignore.Jira
OSAC-1407
Test plan
git check-ignoreconfirms unlisted paths (e.g.overlays/<project-name>/) are ignoredgit check-ignoreconfirms whitelisted overlays (development,_shared) are not ignoredgit ls-files overlays/Summary by CodeRabbit
overlays/<project-name>are gitignored by default, so they don’t appear in version control status.overlays/.gitignoreare tracked.overlays/*by default, while re-including the committed shared overlay tree and selected named overlay directories.