chore(docs): add doc that ocmconfigs are merged#1991
Merged
frewilhelm merged 4 commits intoMar 16, 2026
Merged
Conversation
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Contributor
📝 WalkthroughWalkthroughAdded a single help-text sentence to the CLI configuration flag explaining that multiple discovered configuration files are merged in discovery order; the same explanatory sentence was added to 27 command reference documentation pages. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
cli/docs/reference/ocm.md (1)
43-43: Consider documenting merge precedence/order explicitly.“Will be merged together” is helpful, but users may still not know which location wins on key conflicts. Adding one short sentence about precedence (or linking to it) would prevent ambiguity.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@cli/docs/reference/ocm.md` at line 43, Update the line that reads "If several configuration files are found in the above locations, they will be merged together." to explicitly state the merge precedence/order (or add a one-sentence pointer to the canonical precedence doc) so users know which location wins on key conflicts; locate this text in ocm.md (the sentence beginning "If several configuration files are found in the above locations...") and append a concise sentence like "When keys conflict, values from X override Y" or a link to the detailed precedence rules.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@cli/docs/reference/ocm.md`:
- Line 43: Update the line that reads "If several configuration files are found
in the above locations, they will be merged together." to explicitly state the
merge precedence/order (or add a one-sentence pointer to the canonical
precedence doc) so users know which location wins on key conflicts; locate this
text in ocm.md (the sentence beginning "If several configuration files are found
in the above locations...") and append a concise sentence like "When keys
conflict, values from X override Y" or a link to the detailed precedence rules.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7c9cf959-303b-4569-80e1-3a71c524dfd5
📒 Files selected for processing (30)
cli/cmd/configuration/ocm_config.gocli/docs/reference/ocm.mdcli/docs/reference/ocm_add.mdcli/docs/reference/ocm_add_component-version.mdcli/docs/reference/ocm_completion.mdcli/docs/reference/ocm_completion_bash.mdcli/docs/reference/ocm_completion_fish.mdcli/docs/reference/ocm_completion_powershell.mdcli/docs/reference/ocm_completion_zsh.mdcli/docs/reference/ocm_describe.mdcli/docs/reference/ocm_describe_types.mdcli/docs/reference/ocm_download.mdcli/docs/reference/ocm_download_plugin.mdcli/docs/reference/ocm_download_resource.mdcli/docs/reference/ocm_generate.mdcli/docs/reference/ocm_generate_docs.mdcli/docs/reference/ocm_get.mdcli/docs/reference/ocm_get_component-version.mdcli/docs/reference/ocm_get_types.mdcli/docs/reference/ocm_plugin.mdcli/docs/reference/ocm_plugin_registry.mdcli/docs/reference/ocm_plugin_registry_get.mdcli/docs/reference/ocm_plugin_registry_list.mdcli/docs/reference/ocm_sign.mdcli/docs/reference/ocm_sign_component-version.mdcli/docs/reference/ocm_transfer.mdcli/docs/reference/ocm_transfer_component-version.mdcli/docs/reference/ocm_verify.mdcli/docs/reference/ocm_verify_component-version.mdcli/docs/reference/ocm_version.md
Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com>
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
cli/docs/reference/ocm_sign.md (1)
43-43: Good addition! Consider clarifying merge precedence.The note about configuration file merging is helpful and clearly communicates the behavior. The wording is clean and grammatically correct.
For enhanced clarity, you could optionally specify what happens when multiple configuration files contain conflicting settings (e.g., "later files override earlier ones" or "earlier files take precedence"). However, this is a nice-to-have enhancement rather than a requirement.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@cli/docs/reference/ocm_sign.md` at line 43, Update the merge-note sentence in the ocm_sign.md text to explicitly state the precedence rule when conflicts occur: replace or augment "If multiple configuration files are found, they will be merged in the order they are discovered." with wording that clarifies which file wins on conflict (for example, "If multiple configuration files are found, they will be merged in the order they are discovered; when the same setting appears in multiple files, values from later files override earlier ones."). Ensure the revised sentence appears where the original merge-note is located so readers can immediately understand conflict resolution behavior.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@cli/docs/reference/ocm_sign.md`:
- Line 43: Update the merge-note sentence in the ocm_sign.md text to explicitly
state the precedence rule when conflicts occur: replace or augment "If multiple
configuration files are found, they will be merged in the order they are
discovered." with wording that clarifies which file wins on conflict (for
example, "If multiple configuration files are found, they will be merged in the
order they are discovered; when the same setting appears in multiple files,
values from later files override earlier ones."). Ensure the revised sentence
appears where the original merge-note is located so readers can immediately
understand conflict resolution behavior.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1934e4b3-e411-40ab-a385-e646283316f6
📒 Files selected for processing (30)
cli/cmd/configuration/ocm_config.gocli/docs/reference/ocm.mdcli/docs/reference/ocm_add.mdcli/docs/reference/ocm_add_component-version.mdcli/docs/reference/ocm_completion.mdcli/docs/reference/ocm_completion_bash.mdcli/docs/reference/ocm_completion_fish.mdcli/docs/reference/ocm_completion_powershell.mdcli/docs/reference/ocm_completion_zsh.mdcli/docs/reference/ocm_describe.mdcli/docs/reference/ocm_describe_types.mdcli/docs/reference/ocm_download.mdcli/docs/reference/ocm_download_plugin.mdcli/docs/reference/ocm_download_resource.mdcli/docs/reference/ocm_generate.mdcli/docs/reference/ocm_generate_docs.mdcli/docs/reference/ocm_get.mdcli/docs/reference/ocm_get_component-version.mdcli/docs/reference/ocm_get_types.mdcli/docs/reference/ocm_plugin.mdcli/docs/reference/ocm_plugin_registry.mdcli/docs/reference/ocm_plugin_registry_get.mdcli/docs/reference/ocm_plugin_registry_list.mdcli/docs/reference/ocm_sign.mdcli/docs/reference/ocm_sign_component-version.mdcli/docs/reference/ocm_transfer.mdcli/docs/reference/ocm_transfer_component-version.mdcli/docs/reference/ocm_verify.mdcli/docs/reference/ocm_verify_component-version.mdcli/docs/reference/ocm_version.md
✅ Files skipped from review due to trivial changes (4)
- cli/docs/reference/ocm_transfer.md
- cli/docs/reference/ocm_transfer_component-version.md
- cli/docs/reference/ocm_download_resource.md
- cli/docs/reference/ocm_describe_types.md
🚧 Files skipped from review as they are similar to previous changes (17)
- cli/docs/reference/ocm_completion_fish.md
- cli/docs/reference/ocm_get_component-version.md
- cli/docs/reference/ocm_version.md
- cli/docs/reference/ocm_download.md
- cli/docs/reference/ocm_download_plugin.md
- cli/docs/reference/ocm_verify.md
- cli/docs/reference/ocm_sign_component-version.md
- cli/docs/reference/ocm_plugin_registry_get.md
- cli/docs/reference/ocm_get.md
- cli/cmd/configuration/ocm_config.go
- cli/docs/reference/ocm_generate.md
- cli/docs/reference/ocm_completion_zsh.md
- cli/docs/reference/ocm_describe.md
- cli/docs/reference/ocm_verify_component-version.md
- cli/docs/reference/ocm_plugin.md
- cli/docs/reference/ocm_completion_bash.md
- cli/docs/reference/ocm_generate_docs.md
jakobmoellerdev
approved these changes
Mar 16, 2026
morri-son
approved these changes
Mar 16, 2026
1 task
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add an info that OCM configurations from default locations are merged into one OCM configuration
Summary by CodeRabbit
Total: 32 documentation updates to improve consistency and user guidance across the CLI.