chore: change types to k8s-style Upper Camel Case by morri-son · Pull Request #785 · open-component-model/ocm-website

morri-son · 2026-03-24T11:22:07Z

On-behalf-of: Gerald Morrison (SAP) gerald.morrison@sap.com

What this PR does / why we need it

We want to consistently use k8s UpperCamelCase/v1 typing style as the default notation for input and access types.

Which issue(s) this PR is related to

Related to open-component-model/ocm-project#962

Type of content

Tutorial (getting-started/ or tutorials/)
How-to Guide (how-to/)
Explanation / Concept (concepts/)
Reference (reference/)

Checklist

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

On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

netlify · 2026-03-24T11:22:12Z

✅ Deploy Preview for open-component-model ready!

Name	Link
🔨 Latest commit	`af6c064`
🔍 Latest deploy log	https://app.netlify.com/projects/open-component-model/deploys/69c2b2ec48c45500088971fb
😎 Deploy Preview	https://deploy-preview-785--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-24T11:22:50Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3fe11f9b-3ae9-40af-90a9-d7a28bc8e9f8

📥 Commits

Reviewing files that changed from the base of the PR and between 47213e1 and af6c064.

📒 Files selected for processing (1)

content/docs/how-to/transfer-helm-charts.md

🚧 Files skipped from review as they are similar to previous changes (1)

content/docs/how-to/transfer-helm-charts.md

📝 Walkthrough

Walkthrough

Documentation across multiple pages standardized input/access type identifiers: lowercase or legacy tokens (e.g., helm, file, dir, utf8, localBlob, ociArtifact) were replaced with capitalized, versioned forms (Helm/v1, File/v1, Dir/v1, UTF8/v1, LocalBlob/v1, OCIImage/v1) in examples and reference material.

Changes

Cohort / File(s)	Summary
Concepts `content/docs/concepts/component-identity.md`, `content/docs/concepts/signing-and-verification-concept.md`	Replaced example `access.type` values from legacy tokens (`ociArtifact`, `localBlob`) to `OCIImage/v1` and `LocalBlob/v1` in component descriptor examples.
Getting Started Guides `content/docs/getting-started/create-component-version.md`, `content/docs/getting-started/deploy-helm-chart.md`	Standardized constructor and component descriptor examples to use capitalized versioned input/access types (`File/v1`, `Dir/v1`, `Helm/v1`, `OCIImage/v1`, `LocalBlob/v1`).
How‑To Guides `content/docs/how-to/container-image-usage.md`, `content/docs/how-to/download-resources-from-component-versions.md`, `content/docs/how-to/transfer-helm-charts.md`	Updated resource `access.type` examples to `OCIImage/v1` and adjusted Helm/chart access examples to `Helm/v1` / `LocalBlob/v1` where applicable.
Reference `content/docs/reference/input-and-access-types.md`	Changed canonical type names and example snippets to capitalized versioned forms (`Dir/v1`, `File/v1`, `Helm/v1`, `UTF8/v1`, `LocalBlob/v1`) and noted deprecated aliases.
Tutorials `content/docs/tutorials/advanced-component-constructor.md`, `content/docs/tutorials/configure-resolvers.md`, `content/docs/tutorials/deploy-helm-chart-bootstrap.md`	Updated tutorial examples and expected outputs to use standardized input/access type identifiers (`Helm/v1`, `UTF8/v1`, `File/v1`, `LocalBlob/v1`, `OCIImage/v1`).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

chore: Create and rework docs for topic Security & Trust #731 — Overlapping edits to signing-and-verification docs that touch the same access.type examples.
docs: core model identity #771 — Edits the same component-identity doc and updates access.type identifiers to OCIImage/v1/LocalBlob/v1.
docs: add component authoring how-to guides #739 — Related changes in advanced tutorials and component-constructor docs converting input/access types to capitalized versioned identifiers.

Suggested labels

area/documentation

Suggested reviewers

frewilhelm
jakobmoellerdev
matthiasbruns

Poem

🐰 I hopped through docs both near and far,
Swapped helm for Helm/v1 beneath the star.
LocalBlob and OCIImage now stand tall,
Clear names in examples — tidy for all! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title clearly summarizes the main change: updating type identifiers to Kubernetes-style UpperCamelCase notation across documentation.
Description check	✅ Passed	The pull request description is related to the changeset, explaining the motivation to adopt k8s UpperCamelCase/v1 typing style for input and access types.
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

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

coderabbitai

Actionable comments posted: 1

🤖 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/docs/how-to/transfer-helm-charts.md`:
- Around line 48-51: The snippet uses helmChart: my-chart-1.0.0.tgz which is
invalid for the Helm/v1 access type; update the Helm/v1 entry so helmChart
contains chart coordinates (e.g. "my-chart:1.0.0") or move the version into a
separate version field and set helmChart to the chart name (e.g. helmChart:
my-chart and version: 1.0.0); if you intend to reference a local tarball,
instead use the localBlob access pattern rather than Helm/v1 and keep
helmRepository and Helm/v1-specific fields unchanged.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c65d631b-6be5-4460-9a91-a201ec22ae09

📥 Commits

Reviewing files that changed from the base of the PR and between 8bb92e6 and 289d4b1.

📒 Files selected for processing (11)

content/docs/concepts/component-identity.md
content/docs/concepts/signing-and-verification-concept.md
content/docs/getting-started/create-component-version.md
content/docs/getting-started/deploy-helm-chart.md
content/docs/how-to/container-image-usage.md
content/docs/how-to/download-resources-from-component-versions.md
content/docs/how-to/transfer-helm-charts.md
content/docs/reference/input-and-access-types.md
content/docs/tutorials/advanced-component-constructor.md
content/docs/tutorials/configure-resolvers.md
content/docs/tutorials/deploy-helm-chart-bootstrap.md

jakobmoellerdev · 2026-03-24T14:32:24Z

        type: helmChart
        access:
-          type: helm/v1
+          type: Helm/v1


I tested this type and it broke on 0.2.0

The helmChart field in Helm/v1 access specs expects 'name:version' format, not a filename. Using 'my-chart-1.0.0.tgz' is incorrect; the colon-separated form 'my-chart:1.0.0' is what the OCM CLI parses. Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com>

morri-son · 2026-04-10T08:22:34Z

needs decision on way forward and scope. Will re-open in monorepo once we're clear about the process.

change types to k8s-style Upper Camel Case

289d4b1

On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

morri-son requested a review from a team as a code owner March 24, 2026 11:22

morri-son added the kind/chore chore, maintenance, etc. label Mar 24, 2026

morri-son linked an issue Mar 24, 2026 that may be closed by this pull request

align type notation for access and input open-component-model/ocm-project#962

Closed

7 tasks

coderabbitai Bot reviewed Mar 24, 2026

View reviewed changes

Comment thread content/docs/how-to/transfer-helm-charts.md

jakobmoellerdev reviewed Mar 24, 2026

View reviewed changes

morri-son force-pushed the change-to-upper-camle-case branch from eac6289 to af6c064 Compare March 24, 2026 15:51

morri-son marked this pull request as draft March 25, 2026 17:22

Skarlso mentioned this pull request Apr 10, 2026

Move OCM website to monorepo open-component-model/ocm-project#1003

Closed

3 tasks

morri-son closed this Apr 10, 2026

morri-son removed a link to an issue Apr 10, 2026

align type notation for access and input open-component-model/ocm-project#962

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: change types to k8s-style Upper Camel Case#785

chore: change types to k8s-style Upper Camel Case#785
morri-son wants to merge 2 commits into
open-component-model:mainfrom
morri-son:change-to-upper-camle-case

morri-son commented Mar 24, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

netlify Bot commented Mar 24, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Mar 24, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

jakobmoellerdev Mar 24, 2026

Uh oh!

morri-son commented Apr 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

morri-son commented Mar 24, 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

Uh oh!

netlify Bot commented Mar 24, 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 24, 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 labels

Suggested reviewers

Poem

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jakobmoellerdev Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

morri-son commented Apr 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

morri-son commented Mar 24, 2026 •

edited by coderabbitai Bot

Loading

netlify Bot commented Mar 24, 2026 •

edited

Loading

coderabbitai Bot commented Mar 24, 2026 •

edited

Loading