Skip to content
This repository was archived by the owner on Apr 13, 2026. It is now read-only.

feat: add how-to for OCM CLI container usage#740

Merged
frewilhelm merged 11 commits into
open-component-model:mainfrom
frewilhelm:add-how-to-container-usage
Mar 5, 2026
Merged

feat: add how-to for OCM CLI container usage#740
frewilhelm merged 11 commits into
open-component-model:mainfrom
frewilhelm:add-how-to-container-usage

Conversation

@frewilhelm

@frewilhelm frewilhelm commented Mar 5, 2026

Copy link
Copy Markdown
Contributor

What this PR does / why we need it

This PR adds a How-To on how to use the OCM CLI container (v2). This will be linked by open-component-model/open-component-model#1893.

Which issue(s) this PR is related to

Part of open-component-model/ocm-project#923

Summary by CodeRabbit

  • Documentation
    • Added a new how-to guide for using the OCM CLI container image with prerequisites, step-by-step commands, examples, and registry/authentication notes.
    • Updated Getting Help links to point to internal documentation and a revised issue tracker URL.
  • Chores
    • Added "nerdctl" to the project wordlist.

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
@netlify

netlify Bot commented Mar 5, 2026

Copy link
Copy Markdown

Deploy Preview for open-component-model ready!

Name Link
🔨 Latest commit 0045667
🔍 Latest deploy log https://app.netlify.com/projects/open-component-model/deploys/69a97029049f080008c74845
😎 Deploy Preview https://deploy-preview-740--open-component-model.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Mar 5, 2026

Copy link
Copy Markdown

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 95bb81c2-0d23-454e-9f24-2c5e510cd620

📥 Commits

Reviewing files that changed from the base of the PR and between a397e05 and 0045667.

📒 Files selected for processing (1)
  • .github/config/wordlist.txt

📝 Walkthrough

Walkthrough

Updated a how-to template's "Getting help" links to internal references and added a new how-to doc describing how to use the OCM CLI container image to create and retrieve component versions; also added "nerdctl" to the repo wordlist.

Changes

Cohort / File(s) Summary
How-to template link updates
content_templates/template-how-to.md
Replaced external "Getting help" links with an internal community.md reference and changed the issue-reporting URL to open-component-model/open-component-model/issues.
New container-image how-to
content/docs/how-to/container-image-usage.md
Added a step-by-step guide for using the OCM CLI container image: goals, prerequisites, OCM config/credential examples, Docker run commands to create and retrieve component versions, sample outputs, and notes on certificates and registries.
Repository wordlist
.github/config/wordlist.txt
Added the term nerdctl to the wordlist.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I hopped through docs with careful cheer,
Swapped links and wrote a container primer here.
Commands, configs, and a tiny tweak,
A rabbit's nibble made the guide complete. 🥕📘

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'feat: add how-to for OCM CLI container usage' directly and clearly describes the main change: adding a how-to documentation for OCM CLI container usage, which aligns with the primary file addition (container-image-usage.md).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
@frewilhelm frewilhelm marked this pull request as ready for review March 5, 2026 08:25
@frewilhelm frewilhelm requested a review from a team as a code owner March 5, 2026 08:25

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@content_templates/template-how-to.md`:
- Line 120: There's a stray extra closing parenthesis in the Markdown link in
template-how-to.md: replace the fragment `{{< relref "community/community.md"
>}}))` with `{{< relref "community/community.md" >}})` to fix the syntax error
so the link renders correctly; update the content where the link appears (the
line containing `[Community Support]({{< relref "community/community.md" >}}))`)
to remove the extra `)` and run a quick Markdown render check.

In `@content/docs/how-to/container-usage.md`:
- Line 110: Fix the typo in the documentation string "Depending on you OS, the
path to the certificates may be different" by replacing "you OS" with "your OS"
in the sentence (locate the phrase "Depending on you OS" in
content/docs/how-to/container-usage.md and update it to "Depending on your OS,
the path to the certificates may be different"). Ensure only the grammatical
correction is applied and commit the change.
- Line 91: The docs currently reference the container image string
"ghcr.io/open-component-model/cli:latest", which is not reproducible; change
examples to use a specific version tag (e.g.,
"ghcr.io/open-component-model/cli:vX.Y.Z") or add a brief note in the guide
explaining that pre-built images may not be available for OCM v2 and instruct
users to build from source when images are not published; update the example
lines containing ghcr.io/open-component-model/cli:latest and the surrounding
explanatory text in container-usage.md to reflect the chosen approach.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8b279b9c-92e0-4bda-bd05-3393d5240e1a

📥 Commits

Reviewing files that changed from the base of the PR and between 9a45df4 and aea86cf.

📒 Files selected for processing (2)
  • content/docs/how-to/container-usage.md
  • content_templates/template-how-to.md

Comment thread content_templates/template-how-to.md Outdated
Comment thread content/docs/how-to/container-image-usage.md
Comment thread content/docs/how-to/container-usage.md Outdated
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Comment thread content/docs/how-to/container-usage.md Outdated
Comment thread content/docs/how-to/container-usage.md Outdated
Comment thread content/docs/how-to/container-usage.md Outdated
Comment thread content/docs/how-to/container-usage.md Outdated
Comment thread content/docs/how-to/container-image-usage.md
Comment thread content/docs/how-to/container-usage.md Outdated
Comment thread content/docs/how-to/container-image-usage.md
Comment thread content/docs/how-to/container-image-usage.md
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Comment thread content/docs/how-to/container-image-usage.md
@frewilhelm frewilhelm merged commit 4db70ed into open-component-model:main Mar 5, 2026
10 checks passed
ocmbot Bot pushed a commit that referenced this pull request Mar 5, 2026
<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

This PR adds a How-To on how to use the OCM CLI container (v2). This
will be linked by
open-component-model/open-component-model#1893.

#### Which issue(s) this PR is related to
Part of open-component-model/ocm-project#923

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Added a new how-to guide for using the OCM CLI container image with
prerequisites, step-by-step commands, examples, and
registry/authentication notes.
* Updated Getting Help links to point to internal documentation and a
revised issue tracker URL.
* **Chores**
  * Added "nerdctl" to the project wordlist.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com> 4db70ed
@frewilhelm frewilhelm deleted the add-how-to-container-usage branch March 5, 2026 14:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants