LCORE-1175: Refreshed "Run LCS locally"

[jrobertboos]

Description

Updated documentation for getting started with LCS. Added a script to generate a local-run.yaml that replaces ~/ with the users home directory from run.yaml.

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Tools used to create PR

Identify any AI code assistants used in this PR (for transparency and review context)

• Assisted-by: Cursor

Related Tickets & Documents

• Related Issue #
• Closes LCORE-1175

Checklist before requesting a review

• I have performed a self-review of my code.
• PR has passed all pre-merge test jobs.
• If it is a core feature, I have added thorough tests.

Testing

• Please provide detailed steps to perform tests related to this code change.
• How were the fix/results from this change verified? Please provide relevant screenshots or results.

N/A

Summary by CodeRabbit

Release Notes

• Documentation

  • Redesigned local setup instructions with improved formatting, code blocks, and clearer step-by-step guidance. Includes new verification steps for configuration settings.

• Chores

  • Added automated tool to generate local configuration files from base settings
  • Updated local file handling to properly ignore generated configuration files

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Three changes update local development setup: .gitignore excludes local-run.yaml, README.md restructures installation steps with code blocks and references a generation script, and a new Bash script generates local-run.yaml from run.yaml by expanding home directory paths.

Changes

Cohort / File(s)	Summary
Configuration \.gitignore	Adds local-run.yaml to ignored files under a "Local run files" section
Documentation and Automation README.md, scripts/generate_local_run.sh	Restructures "Run LCS locally" instructions with fenced code blocks; replaces direct run.yaml usage with generate_local_run.sh script; updates server startup command to use local-run.yaml; adds Step 5 to verify LCS lightspeed-stack.yaml settings. New script generates local-run.yaml from run.yaml by substituting ~/ with the user's home directory

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

• tisnik

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly references the main objective of the PR: refreshing the "Run LCS locally" documentation and supporting infrastructure, which aligns with the actual changes (README updates, new script, and .gitignore updates).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

scripts/generate_local_run.sh (1)

21-24: Consider checking sed exit status before declaring success.

If sed fails (e.g., due to write permission issues or disk full), the script still prints a success message. This could be misleading to users.

Suggested improvement

 # Replace ~/ with $HOME/ and write to local-run.yaml
-sed "s|~/|$HOME/|g" "$INPUT_FILE" > "$OUTPUT_FILE"
-
-echo "Successfully generated $OUTPUT_FILE"
+if sed "s|~/|$HOME/|g" "$INPUT_FILE" > "$OUTPUT_FILE"; then
+    echo "Successfully generated $OUTPUT_FILE"
+else
+    echo "Error: Failed to generate $OUTPUT_FILE" >&2
+    exit 1
+fi

README.md (1)

177-180: Add language specifier to the fenced code block.

The code block is missing a language identifier, which affects syntax highlighting and consistency with other code blocks in the document.

Suggested fix

 6. start LCS server
-    ```
+    ```bash
    make run
     ```

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9989b7a and 39b3bbf.

📒 Files selected for processing (3)

• .gitignore
• README.md
• scripts/generate_local_run.sh

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

178-178: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: build-pr
• GitHub Check: E2E: library mode / ci
• GitHub Check: E2E: server mode / ci
• GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request

🔇 Additional comments (3)

.gitignore (1)

194-196: LGTM!

Correctly ignores the generated local-run.yaml file which contains user-specific home directory paths and should not be committed to version control.

scripts/generate_local_run.sh (1)

1-19: LGTM!

Good practices observed:

• Proper shebang and script directory resolution using BASH_SOURCE
• Correct derivation of project root
• Input file existence check with proper error handling to stderr
• Using | as sed delimiter to avoid conflicts with path separators

README.md (1)

155-176: LGTM!

The refreshed documentation is clear and well-structured:

• Logical step ordering starting from dependency installation
• Proper use of fenced code blocks with language specifiers
• Clear explanation of the new local-run.yaml generation workflow
• Correct reference to the new script at ./scripts/generate_local_run.sh

[jrobertboos]

Hey @tisnik, do you think you could give this a look :) Thanks!