Updated Makefile

[tisnik]

Description

Updated Makefile

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: N/A
• Generated by: N/A

Summary by CodeRabbit

Release Notes

• Chores
  • Streamlined the documentation generation workflow by simplifying the build process
  • Added new build targets to support automated documentation generation for developers

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

[coderabbitai]

Walkthrough

The Makefile has been updated with two new documentation generation targets: generate-documentation and doc for developer-focused documentation. The existing openapi-doc target was simplified by removing a post-processing fix step and cleanup operation.

Changes

Cohort / File(s)	Summary
Makefile build targets Makefile	Added generate-documentation target invoking script/gen_doc.py; Added doc target for developer documentation; Updated openapi-doc target to remove fix_openapi_doc.py post-processing and cleanup step, now directly runs openapi-to-markdown

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Single file with straightforward target additions and simplifications
• No complex logic or conditional flows to verify
• Changes are isolated to build configuration

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Updated Makefile' is overly vague and generic, lacking specificity about what was actually changed in the Makefile.	Consider a more specific title that describes the main changes, such as 'Refactor Makefile documentation targets' or 'Add generate-documentation target to Makefile'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

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

---

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)

Makefile (2)

49-50: Ensure scripts/gen_doc.py has proper shebang and execute permissions.

The target invokes scripts/gen_doc.py directly without an interpreter prefix. This requires the script to have:

• A shebang line (e.g., #!/usr/bin/env python3)
• Execute permissions (chmod +x scripts/gen_doc.py)

For consistency with other Python targets in this Makefile (e.g., lines 42, 56), consider using uv run scripts/gen_doc.py instead, which delegates to the project's Python environment.

Apply this diff to ensure consistency with the project's conventions:

 generate-documentation:	## Generate documentation
-	scripts/gen_doc.py
+	uv run scripts/gen_doc.py

---

49-50: Clarify the purpose of redundant generate-documentation and doc targets.

Both targets invoke scripts/gen_doc.py identically with no functional difference:

• generate-documentation (lines 49–50): calls scripts/gen_doc.py
• doc (lines 59–60): calls scripts/gen_doc.py

Clarify the intent:

• If doc is meant as a shorter alias for generate-documentation, consider removing the redundant target to reduce maintenance burden.
• If they serve different purposes (e.g., different subsets of documentation), add distinct commands or parameters to differentiate them.

Also applies to: 59-60

📜 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 dcb4637 and 92b8c00.

📒 Files selected for processing (1)

• Makefile (1 hunks)

⏰ 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). (6)

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

🔇 Additional comments (1)

Makefile (1)

52-53: Verify the removal of post-processing fix step in openapi-doc target.

The updated target removes the scripts/fix_openapi_doc.py dependency and the associated post-processing step that was previously in lines 46–47. This was a multi-step workflow:

openapi-to-markdown → fix_openapi_doc.py → docs/output.md

Now it's a single step directly to docs/output.md. Confirm that:

1. This removal was intentional
2. The output from openapi-to-markdown is valid without the fix script
3. Any functionality previously provided by fix_openapi_doc.py is no longer needed or has been moved elsewhere

If the fix step is still needed, revert to the earlier approach:

-openapi-doc:	docs/openapi.json	## Generate OpenAPI documentation
-	openapi-to-markdown --input_file docs/openapi.json --output_file docs/output.md
+openapi-doc:	docs/openapi.json scripts/fix_openapi_doc.py	## Generate OpenAPI documentation
+	openapi-to-markdown --input_file docs/openapi.json --output_file output.md
+	python3 scripts/fix_openapi_doc.py < output.md > docs/output.md
+	rm output.md