Add support for coping <version>/*.md files to / container by phracek · Pull Request #422 · sclorg/container-common-scripts

phracek · 2026-03-17T11:45:26Z

Add support for coping /*.md files

to /root directory.

After sync to GitLab we have MD files present
in each image.

Relevant issue https://redhat.atlassian.net/browse/RHELMISC-27557

The output looks like, in case in directory are more MD files:

$ make build TARGET=rhel9 SINGLE_VERSION=1.26
make[1]: Entering directory '/root/nginx-container'
1.20/README.md	1.20/SEE_ALSO.md  1.20/USAGE.md
'1.20/README.md' -> '1.20/root/README.md'
'1.20/SEE_ALSO.md' -> '1.20/root/SEE_ALSO.md'
'1.20/USAGE.md' -> '1.20/root/USAGE.md'
1.22/README.md
'1.22/README.md' -> '1.22/root/README.md'
1.22-micro/README.md
'1.22-micro/README.md' -> '1.22-micro/root/README.md'
1.24/README.md
'1.24/README.md' -> '1.24/root/README.md'
1.26/README.md
'1.26/README.md' -> '1.26/root/README.md'
VERSION="1.20" SKIP_SQUASH=1 OS=rhel9 CLEAN_AFTER= DOCKER_BUILD_CONTEXT=.. OPENSHIFT_NAMESPACES="" CUSTOM_REPO="" REGISTRY="""" /usr/bin/env bash common/build.sh

Summary by CodeRabbit

Chores
- Documentation Markdown files are copied into each version's root directory during the build.
- Per-version builds now wait for those documentation files to be copied before running.
- Cleanup now removes the copied Markdown files as part of the standard clean step.

phracek · 2026-03-17T11:45:36Z

[test]

coderabbitai · 2026-03-17T11:45:50Z

📝 Walkthrough

Walkthrough

Adds Make targets to copy and remove per-version Markdown files into each version's root directory, makes $(VERSIONS) depend on the copy step, and updates clean to remove the copied Markdown files during cleanup. (<=50 words)

Changes

Cohort / File(s)	Summary
Build Configuration `common.mk`	Added `copy_md_files` (creates `$(version)/root`, copies `$(version)/*.md` into it, sets read perms) and `remove_md_files` targets; made `$(VERSIONS)` depend on `copy_md_files`; updated `clean` to depend on `remove_md_files` and `clean-images`.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Let's remove generation help.1 to container #421: Modifies common.mk per-version build dependencies and handling of documentation files in version roots.

Suggested reviewers

pkhartsk

Poem

🐇 I hop through folders, swift and spry,
Copying Markdown as versions fly.
Roots fill with notes, neat and bright,
Clean removes them when day turns night. ✨📄

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title contains a typo ('coping' instead of 'copying') and is partially related to the change, referring to a real aspect but with unclear phrasing.	Correct the typo from 'coping' to 'copying' for clarity: 'Add support for copying /*.md files to /root container'

✅ Passed checks (2 passed)

Check name	Status	Explanation
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
Commit unit tests in branch copy_md_files

📝 Coding Plan

Generate coding plan for human review comments

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

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

phracek · 2026-03-17T11:46:18Z

During the our weekly call, we have discovered that container misses /root/help.1 file and readmes are not present as well.
This pull request should fix it.

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

common.mk (1)
85-86: Missing .PHONY declaration for copy_md_files target.

The copy_md_files target should be declared as .PHONY to ensure it always runs regardless of whether a file with that name exists. This is consistent with how other non-file-producing targets in this Makefile are declared.
♻️ Proposed fix

Add copy_md_files to an existing .PHONY declaration or create a new one before the target:
+.PHONY: copy_md_files
 # Copy also all .md files from version directory to the root of
 # container images, so that they are available in the image
 # Currently there is only README.md, but there may be more in the future
 copy_md_files:
Also applies to: 142-146
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@common.mk` around lines 85 - 86, Add a .PHONY declaration for the
copy_md_files target so it always runs (e.g., include copy_md_files in the
existing .PHONY list or add a new `.PHONY: copy_md_files` near the top); update
the Makefile so the copy_md_files target (referenced by the rule for
$(VERSIONS)) is declared phony to avoid skipping when a file named copy_md_files
exists.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@common.mk`:
- Around line 142-146: The copy_md_files Makefile rule is copying from the
project root (cp -v *.md) instead of from each version directory and will fail
if no .md files exist; update the loop in the copy_md_files target to cp from
the version directory (use cp -v "$$version"/*.md "$$version"/root/) and guard
the copy with a existence check such as ls "$$version"/*.md >/dev/null 2>&1 &&
cp -v "$$version"/*.md "$$version"/root/ so the command only runs when files
exist (refer to the copy_md_files target and the $$version variable in the
diff).

---

Nitpick comments:
In `@common.mk`:
- Around line 85-86: Add a .PHONY declaration for the copy_md_files target so it
always runs (e.g., include copy_md_files in the existing .PHONY list or add a
new `.PHONY: copy_md_files` near the top); update the Makefile so the
copy_md_files target (referenced by the rule for $(VERSIONS)) is declared phony
to avoid skipping when a file named copy_md_files exists.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 37ea045f-1884-4900-82f7-d7b3c7196075

📥 Commits

Reviewing files that changed from the base of the PR and between 18f0075 and 02fb671.

📒 Files selected for processing (1)

common.mk

common.mk

github-actions · 2026-03-17T11:51:52Z

Pull Request validation

Failed

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

Success

🟢 CI - All checks have passed

to <version>/root directory. After sync to GitLab we have MD files present in each image. Relevant issue https://redhat.atlassian.net/browse/RHELMISC-27557 Signed-off-by: Petr "Stone" Hracek <phracek@redhat.com>

phracek · 2026-03-17T11:58:26Z

[test]

coderabbitai

🧹 Nitpick comments (1)

common.mk (1)
142-148: Add .PHONY declaration for copy_md_files.

The target produces no output file, so it should be declared .PHONY to match other similar targets in this file (e.g., build, test, clean). This ensures Make always runs it regardless of filesystem state.
♻️ Proposed fix
+.PHONY: copy_md_files
 copy_md_files:
 	`@for` version in $(VERSIONS); do \
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@common.mk` around lines 142 - 148, Add a .PHONY declaration for the Make
target copy_md_files so Make always runs it (like the existing .PHONY list for
build/test/clean); update the .PHONY line(s) to include copy_md_files
(referencing the target name copy_md_files) rather than leaving it as a
file-dependent target.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@common.mk`:
- Around line 142-148: Add a .PHONY declaration for the Make target
copy_md_files so Make always runs it (like the existing .PHONY list for
build/test/clean); update the .PHONY line(s) to include copy_md_files
(referencing the target name copy_md_files) rather than leaving it as a
file-dependent target.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d489d3d2-67f9-4efb-8c2d-c0e535460230

📥 Commits

Reviewing files that changed from the base of the PR and between 02fb671 and 16b15c5.

📒 Files selected for processing (1)

common.mk

github-actions · 2026-03-17T11:59:52Z

Testing Farm results

name	compose	arch	status	started (UTC)	time	logs
RHEL8 - s2i-base-container	RHEL-8.10.0-Nightly	x86_64	✅ passed	17.03.2026 15:31:35	18min 13s	test pipeline
RHEL8 - s2i-perl-container	RHEL-8.10.0-Nightly	x86_64	✅ passed	17.03.2026 15:51:09	27min 48s	test pipeline
Fedora - nginx-container	Fedora-latest	x86_64	✅ passed	17.03.2026 15:41:10	13min 14s	test pipeline
Fedora - s2i-base-container	Fedora-latest	x86_64	✅ passed	17.03.2026 15:19:35	12min 8s	test pipeline
CentOS Stream 9 - nginx-container	CentOS-Stream-9	x86_64	✅ passed	17.03.2026 15:30:47	19min 11s	test pipeline
RHEL10 - s2i-perl-container	RHEL-10-Nightly	x86_64	✅ passed	17.03.2026 15:18:53	27min 38s	test pipeline
CentOS Stream 9 - s2i-perl-container	CentOS-Stream-9	x86_64	✅ passed	17.03.2026 15:35:16	22min 24s	test pipeline
RHEL10 - nginx-container	RHEL-10-Nightly	x86_64	✅ passed	17.03.2026 15:18:53	18min 23s	test pipeline
RHEL8 - postgresql-container	RHEL-8.10.0-Nightly	x86_64	✅ passed	17.03.2026 15:51:58	40min 36s	test pipeline
CentOS Stream 9 - s2i-base-container	CentOS-Stream-9	x86_64	✅ passed	17.03.2026 15:47:15	17min 9s	test pipeline
RHEL9 - s2i-base-container	RHEL-9.6.0-Nightly	x86_64	✅ passed	17.03.2026 15:18:58	21min 49s	test pipeline
CentOS Stream 10 - nginx-container	CentOS-Stream-10	x86_64	✅ passed	17.03.2026 15:18:52	14min 46s	test pipeline
RHEL10 - postgresql-container	RHEL-10-Nightly	x86_64	✅ passed	17.03.2026 15:18:52	25min 4s	test pipeline
RHEL9 - nginx-container	RHEL-9.6.0-Nightly	x86_64	✅ passed	17.03.2026 15:45:21	25min 7s	test pipeline
RHEL10 - s2i-python-container	RHEL-10-Nightly	x86_64	✅ passed	17.03.2026 15:18:52	37min 30s	test pipeline
CentOS Stream 10 - s2i-perl-container	CentOS-Stream-10	x86_64	✅ passed	17.03.2026 15:43:17	23min 46s	test pipeline
CentOS Stream 9 - postgresql-container	CentOS-Stream-9	x86_64	✅ passed	17.03.2026 15:39:14	29min 17s	test pipeline
RHEL9 - postgresql-container	RHEL-9.6.0-Nightly	x86_64	✅ passed	17.03.2026 15:59:38	39min 35s	test pipeline
CentOS Stream 10 - postgresql-container	CentOS-Stream-10	x86_64	✅ passed	17.03.2026 15:18:52	21min 14s	test pipeline
RHEL10 - s2i-base-container	RHEL-10-Nightly	x86_64	✅ passed	17.03.2026 13:48:44	16min 41s	test pipeline
RHEL9 - s2i-perl-container	RHEL-9.6.0-Nightly	x86_64	✅ passed	17.03.2026 15:18:54	29min 47s	test pipeline
CentOS Stream 10 - s2i-base-container	CentOS-Stream-10	x86_64	✅ passed	17.03.2026 15:41:17	13min 37s	test pipeline
RHEL8 - nginx-container	RHEL-8.10.0-Nightly	x86_64	✅ passed	17.03.2026 15:18:52	21min 44s	test pipeline
Fedora - s2i-python-container	Fedora-latest	x86_64	✅ passed	17.03.2026 15:57:13	1h 4min 39s	test pipeline
Fedora - s2i-perl-container	Fedora-latest	x86_64	✅ passed	17.03.2026 15:33:52	40min 13s	test pipeline
CentOS Stream 10 - s2i-python-container	CentOS-Stream-10	x86_64	✅ passed	17.03.2026 15:55:36	1h 9min 25s	test pipeline
Fedora - postgresql-container	Fedora-latest	x86_64	✅ passed	17.03.2026 15:18:53	23min 32s	test pipeline
RHEL8 - s2i-python-container	RHEL-8.10.0-Nightly	x86_64	✅ passed	17.03.2026 15:55:28	1h 32min 44s	test pipeline
CentOS Stream 9 - s2i-python-container	CentOS-Stream-9	x86_64	✅ passed	17.03.2026 15:25:32	1h 49min 40s	test pipeline
RHEL9 - s2i-python-container	RHEL-9.6.0-Nightly	x86_64	✅ passed	17.03.2026 15:41:23	1h 45min 12s	test pipeline

pkhartsk

Works for me when building postgresql-container locally

common.mk

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

phracek · 2026-03-17T15:18:39Z

[test]

phracek · 2026-03-18T08:03:17Z

@pkubatrh Added MD files removal. As soon as You are fine with it please Approve.

pkhartsk

LGTM

deploying sclorg/container-common-scripts#422 The next step will be sync to GitLab repo and see, whether README.md file will be present in GitLab repo in `root` directory Signed-off-by: Petr "Stone" Hracek <phracek@redhat.com>

Deliver fix for copying version during the tests sclorg/container-common-scripts#422 This is needed to have MD files in downstream GitLab repos Signed-off-by: Petr "Stone" Hracek <phracek@redhat.com>

phracek added the ready for review label Mar 17, 2026

phracek requested review from pkhartsk and pkubatrh March 17, 2026 11:46

coderabbitai bot reviewed Mar 17, 2026

View reviewed changes

common.mk Show resolved Hide resolved

github-actions bot added pr/failing-ci pr/missing-review labels Mar 17, 2026

Add support for coping <version>/*.md files

16b15c5

to <version>/root directory. After sync to GitLab we have MD files present in each image. Relevant issue https://redhat.atlassian.net/browse/RHELMISC-27557 Signed-off-by: Petr "Stone" Hracek <phracek@redhat.com>

phracek force-pushed the copy_md_files branch from 02fb671 to 16b15c5 Compare March 17, 2026 11:56

coderabbitai bot reviewed Mar 17, 2026

View reviewed changes

pkhartsk approved these changes Mar 17, 2026

View reviewed changes

pkubatrh reviewed Mar 17, 2026

View reviewed changes

common.mk Show resolved Hide resolved

Add support for deleing MD files created by function create_md_files

f57f495

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

github-actions bot removed the pr/failing-ci label Mar 17, 2026

github-actions bot added the pr/failing-ci label Mar 17, 2026

github-actions bot removed the pr/failing-ci label Mar 18, 2026

pkhartsk approved these changes Mar 18, 2026

View reviewed changes

phracek merged commit bf3bb46 into master Mar 18, 2026
35 checks passed

phracek deleted the copy_md_files branch March 18, 2026 09:26

phracek mentioned this pull request Mar 18, 2026

Update container-common-scripts with update README.md deployment sclorg/httpd-container#285

Merged

This was referenced Mar 19, 2026

Update container-common-scripts sclorg/postgresql-container#650

Merged

Update container-common-scripts sclorg/mariadb-container#325

Merged

phracek mentioned this pull request Mar 19, 2026

Update container-common-scripts sclorg/mysql-container#432

Merged

phracek mentioned this pull request Mar 19, 2026

Update container-common-scripts sclorg/redis-container#220

Merged

This was referenced Mar 19, 2026

Update container-common-scripts sclorg/s2i-base-container#359

Merged

Update container-common-scripts sclorg/valkey-container#58

Merged

Update container-common-scripts sclorg/varnish-container#187

Merged

This was referenced Mar 19, 2026

Update container-common-scripts sclorg/s2i-nodejs-container#533

Merged

Update container-common-scripts sclorg/s2i-python-container#791

Merged

coderabbitai bot mentioned this pull request Mar 19, 2026

Do not fail remove obsolete functions #420

Merged

Conversation

phracek commented Mar 17, 2026 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

phracek commented Mar 17, 2026

Uh oh!

coderabbitai bot commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

❌ Failed checks (1 inconclusive)

Uh oh!

phracek commented Mar 17, 2026

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request validation

Failed

Success

Uh oh!

phracek commented Mar 17, 2026

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing Farm results

Uh oh!

pkhartsk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

phracek commented Mar 17, 2026

Uh oh!

phracek commented Mar 18, 2026

Uh oh!

pkhartsk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

phracek commented Mar 17, 2026 •

edited by github-actions bot

Loading

coderabbitai bot commented Mar 17, 2026 •

edited

Loading

github-actions bot commented Mar 17, 2026 •

edited

Loading

github-actions bot commented Mar 17, 2026 •

edited

Loading