Skip to content

Conversation

@tisnik
Copy link
Contributor

@tisnik tisnik commented Sep 2, 2025

Description

LCORE-583: print all Makefile targets

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

Related Tickets & Documents

  • Related Issue #LCORE-583

Summary by CodeRabbit

  • Chores
    • Improved Makefile help output to list targets that include path separators, making all documentation-related tasks visible. No changes to build behavior.
  • Documentation
    • Added README entries for new documentation targets:
      • docs/config.puml – generate PlantUML class diagram for configuration.
      • docs/config.png – generate an image of the configuration graph.
      • docs/config.svg – generate an SVG of the configuration graph.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 2, 2025

Walkthrough

Updated the Makefile’s help-target regex to include “/” in target names. README adds three documentation-related targets: docs/config.puml, docs/config.png, and docs/config.svg. No build logic or control flow changed.

Changes

Cohort / File(s) Summary
Help output matching
Makefile
Broadened grep regex from ^[ a-zA-Z0-9_.-]+:.*?## .*$$ to ^[ a-zA-Z0-9_./-]+:.*?## .*$$ to include targets with “/” in help listing; awk formatting unchanged.
Documentation targets listing
README.md
Added entries describing make targets: docs/config.puml, docs/config.png, docs/config.svg; content-only update.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my whiskers at targets anew,
A slash in the name? I’ll list those too.
Docs sprout leaves—PNG, SVG bloom—
Config vines in PlantUML zoom.
Thump goes my paw: “help” reads clean,
Carrots of clarity, crisp and keen. 🥕

✨ Finishing Touches
🧪 Generate unit tests
  • 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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
README.md (1)

570-572: Document prerequisites for docs/config. targets*

Call out required tools so users don’t hit missing-binary errors when running these targets.

-docs/config.puml                  Generate PlantUML class diagram for configuration
-docs/config.png                   Generate an image with configuration graph
-docs/config.svg                   Generate an SVG with configuration graph
+docs/config.puml                  Generate PlantUML class diagram for configuration (requires: pyreverse)
+docs/config.png                   Generate an image with configuration graph (requires: Java + ${PATH_TO_PLANTUML}/plantuml.jar)
+docs/config.svg                   Generate an SVG with configuration graph (requires: Java + ${PATH_TO_PLANTUML}/plantuml.jar, xmllint)
Makefile (1)

108-110: Make help more robust when multiple Makefiles are listed

If $(MAKEFILE_LIST) expands to multiple files, grep will prefix matches with “filename:”, which breaks the awk formatting. Suppress filenames and optionally sort for stable output.

-	@grep -E '^[ a-zA-Z0-9_./-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
-		awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-33s\033[0m %s\n", $$1, $$2}'
+	@grep -hE '^[ a-zA-Z0-9_./-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
+		sort | \
+		awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-33s\033[0m %s\n", $$1, $$2}'

To verify:

  • Add include directives or a secondary Makefile and confirm “make help” still formats targets correctly.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 18fdf3c and 8b41f92.

📒 Files selected for processing (2)
  • Makefile (1 hunks)
  • README.md (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). (2)
  • GitHub Check: build-pr
  • GitHub Check: e2e_tests

@tisnik tisnik merged commit 3fa6d3f into lightspeed-core:main Sep 2, 2025
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant