NO-JIRA: Add project documentation to CLAUDE.md

[zaneb]

Record Claude's experience in running the unit tests and discovering the project structure to CLAUDE.md so that in future it will not have to rediscover any of it from first principles.

[openshift-ci-robot]

@zaneb: This pull request explicitly references no jira issue.

Details

In response to this:

Record Claude's experience in running the unit tests and discovering the project structure to CLAUDE.md so that in future it will not have to rediscover any of it from first principles.

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.

[coderabbitai]

Walkthrough

Adds a new Claude documentation file with development guidance, refactors hard-coded temporary paths to use os.TempDir() for portability in the assisted installer controller, and converts the ControllerLogFile from a compile-time constant to a runtime-initialized package variable.

Changes

Cohort / File(s)	Summary
Documentation CLAUDE.md	New file added with development guidance covering build commands, testing procedures, linting, code generation, architecture components, configuration approaches, and common tasks for Claude Code usage.
Temporary Path Refactoring src/assisted_installer_controller/assisted_installer_controller.go	Replaced hard-coded /tmp paths with os.TempDir() calls in logHostResolvConf (for var-run-resolv.conf and host-resolv.conf variants) and collectMustGatherLogs (for must-gather directory).
Log Configuration src/common/common.go	Converted ControllerLogFile from a compile-time constant string to a package-level variable initialized with system temp directory path, shifting initialization from build-time to runtime.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• ControllerLogFile initialization timing: Verify that runtime initialization of the log file path does not create race conditions or initialization order issues with other package-level variables or initialization functions.
• Temporary directory fallback behavior: Confirm that os.TempDir() behavior aligns with previous hard-coded /tmp assumptions across all target deployment environments.

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The pull request title "Add project documentation to CLAUDE.md" accurately describes one significant part of the changeset—the addition of new documentation in CLAUDE.md. However, the changeset includes material functional code changes beyond documentation: path refactoring in assisted_installer_controller.go (replacing hardcoded /tmp paths with os.TempDir()) and a change in common.go converting ControllerLogFile from a compile-time constant to a runtime variable. While the title refers to a real aspect of the change, it represents only one file out of three modified and does not convey the scope of the functional refactoring involved in the pull request.	Consider revising the title to better reflect the full scope of changes, such as "Refactor temporary paths and add Claude documentation" or "Use os.TempDir() and add CLAUDE.md documentation." This would more accurately represent that the PR includes both code refactoring and documentation additions, helping reviewers understand the true nature of the changes at a glance.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	The pull request description "Record Claude's experience in running the unit tests and discovering the project structure to CLAUDE.md so that in future it will not have to rediscover any of it from first principles" is clearly related to the changeset, providing context and intent for the primary change of adding CLAUDE.md documentation. While the description does not mention the modifications to assisted_installer_controller.go and common.go, it appropriately explains the purpose of the main addition to the repository. Given that this is a lenient check requiring only that the description be related and not completely off-topic, the description meets the criteria.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (2.5.0)

Error: can't load config: unsupported version of the configuration: "" See https://golangci-lint.run/docs/product/migration-guide for migration instructions
The command is terminated due to an error: can't load config: unsupported version of the configuration: "" See https://golangci-lint.run/docs/product/migration-guide for migration instructions

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: zaneb
Once this PR has been reviewed and has the lgtm label, please assign omertuc for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/common/common.go (1)

43-45: Consider making ControllerLogFile immutable after initialization.

The change from a compile-time constant to a runtime-determined variable improves portability. However, as a package-level var, it can now be reassigned at runtime, potentially leading to unexpected behavior if modified accidentally.

If reassignment is not intended, consider one of these approaches:

1. Initialize it once in an init() function (it would still be a var but the intent is clearer)
2. Use sync.Once if there's a need for lazy initialization
3. Add a comment documenting that this should not be modified after initialization

If the current approach is intentional and reassignment is desired, you can ignore this comment.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between bcef302 and d23d109.

📒 Files selected for processing (3)

• CLAUDE.md (1 hunks)
• src/assisted_installer_controller/assisted_installer_controller.go (2 hunks)
• src/common/common.go (1 hunks)

🔇 Additional comments (3)

src/assisted_installer_controller/assisted_installer_controller.go (2)

1243-1243: Good portability improvement!

The change to use os.TempDir() for the temporary resolv.conf variants improves cross-platform compatibility while correctly keeping /etc/resolv.conf as a hardcoded system path.

---

1409-1409: Excellent portability improvement.

Using os.TempDir() instead of the hardcoded /tmp path makes the code more portable across different operating systems and configurations.

CLAUDE.md (1)

1-165: Comprehensive documentation for AI-assisted development.

This documentation file is well-structured and provides excellent guidance for Claude Code. The coverage of build commands, testing, architecture, and common development tasks is thorough and practical.

A few minor suggestions for potential enhancement:

• Consider adding a "Quick Start" section at the top for first-time contributors
• The "Running tests directly with go" guidance (lines 59-62) could mention that -count=1 disables test caching
• Line 135: The Go version (1.21) may need updating over time - consider referencing go.mod as the source of truth

These are optional improvements; the current documentation is already very helpful.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 46.92%. Comparing base (bcef302) to head (d23d109).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1319   +/-   ##
=======================================
  Coverage   46.92%   46.92%           
=======================================
  Files          19       19           
  Lines        4149     4149           
=======================================
  Hits         1947     1947           
  Misses       1994     1994           
  Partials      208      208           

Files with missing lines	Coverage Δ
...taller_controller/assisted_installer_controller.go	75.88% <100.00%> (ø)
src/common/common.go	43.61% <ø> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[openshift-ci]

@zaneb: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/okd-scos-e2e-aws-ovn	d23d109	link	false	/test okd-scos-e2e-aws-ovn

Full PR test history. Your PR dashboard.

Details

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 kubernetes-sigs/prow repository. I understand the commands that are listed here.