LCORE-584: add missing Makefile targets into documentation

[tisnik]

Description

LCORE-584: add missing Makefile targets into documentation

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-584

Summary by CodeRabbit

• New Features

  • Exposed a formatting command as a public target for easier access.
  • Standardized Make targets with clear inline descriptions for linting, type checks, docs, verification, packaging, and uploads.
  • Added a help target to display available commands.

• Documentation

  • Updated README to list and describe available Make targets.
  • Clarified wording for end-to-end test target and developer documentation generation.

• Chores

  • Improved Make target descriptions to produce consistent help output without altering underlying commands.

[coderabbitai]

Walkthrough

Makefile target descriptions were standardized and exposed in help output. An internal target _black was renamed to black. The README’s Make targets list was updated to reflect these names and descriptions. Functional commands remain unchanged; updates are limited to target naming and descriptive text.

Changes

Cohort / File(s)	Summary
Makefile targets and help annotations Makefile	- Rename _black → black (same command). - Add/adjust inline descriptions for: doc, black, pylint, pyright, docstyle, ruff, verify, distribution-archives, upload-distribution-archives, test-e2e. - No command changes beyond visibility/description updates.
README Make targets sync README.md	- Update test-e2e description to “Run end to end tests for the service.” - List new/visible targets: doc, black, pylint, pyright, docstyle, ruff, help with concise descriptions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• LCORE-583: print all Makefile targets #477 — Also modifies Makefile help/listing behavior, aligning how targets appear in help.
• LCORE-240: Makefile targets + updated documentation #222 — Adds/annotates distribution-related Make targets and help text similar to this PR.

Poem

A hop, a skip, a target renamed—how slick!
I twitch my whiskers: black is public, quick.
Docs and linters neatly on display,
Make help now reads the tidy way.
Thump-thump! I dance in CI’s glow—
End-to-end we’re good to go! 🐇✨

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (6)

README.md (2)

563-563: Hyphenate “end‑to‑end”.

Prefer “end-to-end” per common style; also keep this consistent with the Makefile.

-test-e2e                          Run end to end tests for the service
+test-e2e                          Run end-to-end tests for the service

---

575-579: Tool naming/wording nits: “analyzer” (US) and “pydocstyle”.

Use “analyzer” for consistency and refer to the tool by name “pydocstyle”.

-pylint                            Check source code using Pylint static code analyser
+ pylint                           Check source code using Pylint static code analyzer
@@
-docstyle                          Check the docstring style using Docstyle checker
+docstyle                          Check docstring conventions with pydocstyle

Makefile (4)

23-24: Hyphenate “end‑to‑end”.

Minor wording tweak for consistency with docs.

-test-e2e: ## Run end to end tests for the service
+test-e2e: ## Run end-to-end tests for the service

---

48-50: Run the doc generator under the project’s virtual env.

Invoking the script via uv+python is more robust (shebang/executable bit not required) and consistent with other targets.

-doc:	## Generate documentation for developers
-	scripts/gen_doc.py
+doc:	## Generate documentation for developers
+	uv run python scripts/gen_doc.py

---

73-83: Wording nits: “analyzer” and “pydocstyle”.

Align terminology with tool names.

-pylint:	## Check source code using Pylint static code analyser
+pylint:	## Check source code using Pylint static code analyzer
@@
-docstyle:	## Check the docstring style using Docstyle checker
+docstyle:	## Check docstring conventions with pydocstyle

---

88-95: Shorten verify body (checkmake maxbodylength).

Collapse repeated invocations into one; matches the static-analysis hint.

-verify:	## Run all linters
-	$(MAKE) black
-	$(MAKE) pylint
-	$(MAKE) pyright
-	$(MAKE) ruff
-	$(MAKE) docstyle
-	$(MAKE) check-types
+verify:	## Run all linters
+	$(MAKE) $(LINT_TARGETS)

Add this near the top with other vars:

LINT_TARGETS := black pylint pyright ruff docstyle check-types

📜 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 3fa6d3f and ef4829e.

📒 Files selected for processing (2)

• Makefile (3 hunks)
• README.md (1 hunks)

🧰 Additional context used

🪛 checkmake (0.2.2)

Makefile

[warning] 88-88: Target body for "verify" exceeds allowed length of 5 (6).

(maxbodylength)

⏰ 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