Skip to content

Let's remove generation help.1 to container#421

Open
phracek wants to merge 1 commit intomasterfrom
remove_golang
Open

Let's remove generation help.1 to container#421
phracek wants to merge 1 commit intomasterfrom
remove_golang

Conversation

@phracek
Copy link
Member

@phracek phracek commented Mar 11, 2026

Let's remove generation help.1 to container completelly.

I would prefer also add into each container
file called 'USAGE.md' from 'README.md'

I would like to avoid duplication from README.md

Summary by CodeRabbit

  • Chores
    • Simplified the build pipeline by removing automatic help documentation file generation from the version build process.

completelly.

I would prefer also add into each container
file called 'USAGE.md' from 'README.md'

I would like to avoid duplication from README.md

Signed-off-by: Petr "Stone" Hracek <phracek@redhat.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2026

📝 Walkthrough

Walkthrough

A Makefile change that removes the per-version build dependency on root/help.1. The recipe generating help.1 from README.md via go-md2man is deleted, decoupling help file generation from the version build pipeline.

Changes

Cohort / File(s) Summary
Build Configuration
common.mk
Removed per-version prerequisite to root/help.1; deleted recipe for generating help.1 from README.md using go-md2man, mkdir, and chmod. Version build targets no longer depend on help file generation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A help file's journey ends today,
No more does it block the build's way,
Versions now run free and fleet,
Without the prerequisite's beat,
The pipeline hops on, light and light! 🌟

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly describes the main change: removing the generation of help.1 from the container build process in common.mk.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch remove_golang

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

@github-actions
Copy link

github-actions bot commented Mar 11, 2026

Pull Request validation

Failed

🔴 Failed or pending checks:

  • lint[in_progress]

🔴 Review - Missing review from a member (1 required)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant