chore: update identity type to `OCIRegistry` and replace `pathprefix` with `path` by jakobmoellerdev · Pull Request #759 · open-component-model/ocm-website

jakobmoellerdev · 2026-03-16T12:56:45Z

What this PR does / why we need it

Corrects all documentation references of our OCI credentials to be of the OCIRegistry type and patches up pathprefix towards path to stay consistent.

Which issue(s) this PR is related to

Fix open-component-model/ocm-project#916

requires open-component-model/open-component-model#1992

Type of content

Tutorial (getting-started/ or tutorials/)
How-to Guide (how-to/)
Explanation / Concept (concepts/)
Reference (reference/)
Other (infrastructure, config, fixes)

Checklist

I have read and followed the Contributing Guide
All commands/code snippets are tested and can be copy-pasted

Summary by CodeRabbit

Documentation
- Updated credential identity type references across configuration examples and guides.
- Clarified path matching behavior with glob pattern guidance for credential configuration.
- Updated legacy credential compatibility guidance and configuration examples to reflect current system expectations.

… with `path` Signed-off-by: Jakob Möller <contact@jakob-moeller.com>

netlify · 2026-03-16T12:56:50Z

✅ Deploy Preview for open-component-model ready!

Name	Link
🔨 Latest commit	`a94529b`
🔍 Latest deploy log	https://app.netlify.com/projects/open-component-model/deploys/69b7fe102c4b1c00070a1d29
😎 Deploy Preview	https://deploy-preview-759--open-component-model.netlify.app
📱 Preview on mobile	Toggle 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 · 2026-03-16T12:56:52Z

📝 Walkthrough

Walkthrough

Six documentation files are updated to reflect credential identity system changes: replacing OCIRepository with OCIRegistry as the consumer identity type, updating field name from pathprefix to path, and adding guidance on glob pattern usage for path matching semantics.

Changes

Cohort / File(s)	Summary
Identity Type Updates `content/docs/concepts/credential-system.md`, `content/docs/how-to/configure-multiple-credentials.md`, `content/docs/how-to/container-image-usage.md`, `content/docs/tutorials/credential-resolution.md`	Replaces OCIRepository with OCIRegistry across identity examples, conceptual descriptions, and configuration snippets to align with updated credential system expectations.
Field Name and Matching Semantics `content/docs/how-to/legacy-credential-compatibility.md`, `content/docs/tutorials/configure-credentials-for-controllers.md`	Changes pathprefix field to path and clarifies that path matching requires glob patterns (e.g., `/` or `/*`) for prefix-like matching behavior; adds callout documenting path matching limitations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

docs: refine credential system documentation #732: Directly modifies the same credential documentation files with related credential identity type and field name changes (OCIRepository ↔ OCIRegistry, path/pathprefix updates).

Suggested reviewers

matthiasbruns
morri-son

Poem

🐰 From OCIRepository's name, we now see,
OCIRegistry's the identity to be!
Pathprefix fades to path so bright,
With glob patterns guiding the light,
Credentials matched, perfectly tight! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The PR addresses documentation objectives from issue `#916`, including updating identity types to OCIRegistry and replacing pathprefix with path, but does not address code-level requirements for credential resolution logic.	This PR handles documentation updates only; verify that separate PRs address the code-level requirements in `#916` (changing consumer identity in oci package, scheme matching logic, identity property defaulting).

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately summarizes the main changes: updating identity type to OCIRegistry and replacing pathprefix with path across documentation files.
Out of Scope Changes check	✅ Passed	All changes are scoped to documentation files and focus on updating identity types and field names as specified in the PR objectives.
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

📝 Coding Plan

Generate coding plan for human review comments

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

coderabbitai

🧹 Nitpick comments (1)

content/docs/how-to/legacy-credential-compatibility.md (1)
89-89: Consider clarifying identity type variance in legacy configs.

While the example shows OCIRegistry as unchanged (which is correct for configs that already used this type), some legacy configurations may have used OCIRepository. Consider adding a brief note that if your legacy config used OCIRepository, it should be updated to OCIRegistry.
📝 Suggested clarification
-- `OCIRegistry` consumer identity type (unchanged)
+- `OCIRegistry` consumer identity type (unchanged; if your legacy config used `OCIRepository`, update it to `OCIRegistry`)
Alternatively, add a separate callout or bullet point to handle the OCIRepository → OCIRegistry case explicitly.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/docs/how-to/legacy-credential-compatibility.md` at line 89, Add a
brief clarifying note in the legacy-credential compatibility doc explaining that
some legacy configs may use the identity type OCIRepository and must be updated
to OCIRegistry; specifically, in the section around the "`OCIRegistry` consumer
identity type (unchanged)" sentence, append a short sentence or add a
bullet/callout that explicitly instructs users to replace OCIRepository with
OCIRegistry in legacy configs and show the expected updated key name.

🤖 Prompt for all review comments with AI agents

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

Nitpick comments:
In `@content/docs/how-to/legacy-credential-compatibility.md`:
- Line 89: Add a brief clarifying note in the legacy-credential compatibility
doc explaining that some legacy configs may use the identity type OCIRepository
and must be updated to OCIRegistry; specifically, in the section around the
"`OCIRegistry` consumer identity type (unchanged)" sentence, append a short
sentence or add a bullet/callout that explicitly instructs users to replace
OCIRepository with OCIRegistry in legacy configs and show the expected updated
key name.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 8cecd921-9019-421c-ae2a-f1d32c910f2c

📥 Commits

Reviewing files that changed from the base of the PR and between 1b457dd and a94529b.

📒 Files selected for processing (6)

content/docs/concepts/credential-system.md
content/docs/how-to/configure-multiple-credentials.md
content/docs/how-to/container-image-usage.md
content/docs/how-to/legacy-credential-compatibility.md
content/docs/tutorials/configure-credentials-for-controllers.md
content/docs/tutorials/credential-resolution.md

… with `path` (#759)  #### What this PR does / why we need it Corrects all documentation references of our OCI credentials to be of the OCIRegistry type and patches up pathprefix towards path to stay consistent. #### Which issue(s) this PR is related to  Fix open-component-model/ocm-project#916 requires open-component-model/open-component-model#1992 #### Type of content  - [ ] Tutorial (`getting-started/` or `tutorials/`) - [ ] How-to Guide (`how-to/`) - [ ] Explanation / Concept (`concepts/`) - [ ] Reference (`reference/`) - [x] Other (infrastructure, config, fixes) #### Checklist - [x] I have read and followed the [Contributing Guide](https://github.com/open-component-model/ocm-website/blob/main/CONTRIBUTING.md) - [x] All commands/code snippets are tested and can be copy-pasted  ## Summary by CodeRabbit * **Documentation** * Updated credential identity type references across configuration examples and guides. * Clarified path matching behavior with glob pattern guidance for credential configuration. * Updated legacy credential compatibility guidance and configuration examples to reflect current system expectations.  Signed-off-by: Jakob Möller <contact@jakob-moeller.com> 7b47951

chore: update identity type to OCIRegistry and replace pathprefix…

a94529b

… with `path` Signed-off-by: Jakob Möller <contact@jakob-moeller.com>

jakobmoellerdev marked this pull request as ready for review March 16, 2026 13:07

jakobmoellerdev requested a review from a team as a code owner March 16, 2026 13:07

coderabbitai Bot reviewed Mar 16, 2026

View reviewed changes

morri-son approved these changes Mar 16, 2026

View reviewed changes

morri-son merged commit 7b47951 into open-component-model:main Mar 16, 2026
10 checks passed

morri-son deleted the fixup-ocireg branch March 16, 2026 15:15

This was referenced Mar 17, 2026

chore: Upgrade Hugo, node and npm #762

Closed

chore: update Hugo, Node and npm versions, fix security issue #763

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: update identity type to `OCIRegistry` and replace `pathprefix` with `path`#759

chore: update identity type to `OCIRegistry` and replace `pathprefix` with `path`#759
morri-son merged 1 commit into
open-component-model:mainfrom
jakobmoellerdev:fixup-ocireg

jakobmoellerdev commented Mar 16, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

netlify Bot commented Mar 16, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Mar 16, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

❌ Failed checks (1 warning)

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

jakobmoellerdev commented Mar 16, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it

Which issue(s) this PR is related to

Type of content

Checklist

Summary by CodeRabbit

Uh oh!

netlify Bot commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for open-component-model ready!

Uh oh!

coderabbitai Bot commented Mar 16, 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 warning)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jakobmoellerdev commented Mar 16, 2026 •

edited by coderabbitai Bot

Loading

netlify Bot commented Mar 16, 2026 •

edited

Loading

coderabbitai Bot commented Mar 16, 2026 •

edited

Loading