Skip to content

chore: update credentials migration planning#2520

Merged
jakobmoellerdev merged 6 commits into
open-component-model:mainfrom
matthiasbruns:feat/1047_typed_credentials_adr_rescope
May 21, 2026
Merged

chore: update credentials migration planning#2520
jakobmoellerdev merged 6 commits into
open-component-model:mainfrom
matthiasbruns:feat/1047_typed_credentials_adr_rescope

Conversation

@matthiasbruns

@matthiasbruns matthiasbruns commented May 15, 2026

Copy link
Copy Markdown
Contributor

What this PR does / why we need it

This ADR update shortens the review time of the credentials migration EPIC open-component-model/ocm-project#702

Since all of the next phases are breaking anyway, we can reshuffle how the migration continues.
The ADR update updates all post-typed-credentials creations and tries to reduce the amount of binding released by rescoping the work order.

This means that

  • phase 3 still updated the plugin interfaces in the credentials bindings, but also cleans up the deprecated Resolve calls within the binding
  • phase 4 still focusses on the repository interface changes

we cannot merge phase 3 & 4 interface changes, since they depend on another. The consumer and cli/controller update will be done in between to reduce the impact on other devs.

Which issue(s) this PR fixes

Contributes:
open-component-model/ocm-project#1055
open-component-model/ocm-project#1047

@matthiasbruns
chore: update credentials migration planning
9bbe335 
On-behalf-of: SAP <matthias.bruns@sap.com>
Signed-off-by: Matthias Bruns <git@matthiasbruns.com>
@netlify

netlify Bot commented May 15, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for ocm-website canceled.

Name Link
🔨 Latest commit 693266c
🔍 Latest deploy log https://app.netlify.com/projects/ocm-website/deploys/6a0eaeac2e750c0008e5e5ba

@coderabbitai

coderabbitai Bot commented May 15, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 9da0bf2e-8f96-4ad3-bd03-a176065eeb13

📥 Commits

Reviewing files that changed from the base of the PR and between c7e5118 and 3bf8e9d.

📒 Files selected for processing (1)
  • docs/adr/0021_typed_credentials.md
📝 Walkthrough

Walkthrough

ADR 0021 defines a phased migration (phases 3–6) from map[string]string-based credential interfaces to runtime.Typed, removing Resolve methods and handling interim APIs via DirectCredentials assertions. The changelog records that Resolve is removed outright without deprecation, phase 6 cleanup is absorbed, binding re-releases are scheduled, and DirectCredentials/v1 remains as legacy bridge.

Changes

Typed Credentials Migration Path

Layer / File(s) Summary
Phased migration plan and decision record
docs/adr/0021_typed_credentials.md		 Migration path section expands with detailed Phase 3–6 breakdown describing removal of map[string]string Resolve from credential and repository plugin interfaces (Phase 3), updates to repository-facing interfaces accepting runtime.Typed with per-binding re-releases (Phase 4), consumer migration off inline assertions (Phase 5), and cleanup verification (Phase 6). Changelog entry for 2026-05-15 documents finalized decisions: Resolve is removed outright without deprecation window, phase 6 cleanup is absorbed into phases 3–4, bindings/go/credentials is cut once in Phase 3, bindings/go/plugin re-releases in Phase 4, no generic typed-to-map helper is provided, and FromDirectCredentials + DirectCredentials/v1 remain as the legacy bridge.

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly Related PRs

Suggested Reviewers

  • fabianburth
  • jakobmoellerdev
  • morri-son

Poem

🐰 A rabbit's ode to migration grand,
From string-maps wild to typed-land,
Phase three through six, a path so clear,
Credentials flow, no more to fear!
Direct and typed, the future's here! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: update credentials migration planning' clearly summarizes the main change—updating migration planning documentation—and aligns with the PR's primary focus on revising the ADR.
Description check ✅ Passed The description is directly related to the changeset, explaining the motivation (shortening review time), the reshaped migration phases (Phase 3 and 4 clarifications), and linking to related issues.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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.

@github-actions github-actions Bot added kind/chore chore, maintenance, etc. size/s Small area/documentation Documentation related labels May 15, 2026
@matthiasbruns matthiasbruns marked this pull request as ready for review May 15, 2026 08:58
fabianburth
fabianburth reviewed May 20, 2026
View reviewed changes
Comment thread docs/adr/0021_typed_credentials.md Outdated
matthiasbruns and others added 2 commits May 20, 2026 15:26
@matthiasbruns
Merge branch 'main' into feat/1047_typed_credentials_adr_rescope
7bc8f9b
@matthiasbruns
chore: update adr to clarify, that ResolveTyped will be renamed to Re…
c5ad974 
…solve and a hard cut is being made

On-behalf-of: SAP <matthias.bruns@sap.com>
Signed-off-by: Matthias Bruns <git@matthiasbruns.com>
@jakobmoellerdev jakobmoellerdev merged commit 5369fd2 into open-component-model:main May 21, 2026
24 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 21, 2026
Merged
@coderabbitai coderabbitai Bot mentioned this pull request Jun 1, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fabianburth fabianburth fabianburth left review comments

@jakobmoellerdev jakobmoellerdev jakobmoellerdev approved these changes

Assignees

No one assigned

Labels

area/documentation Documentation related kind/chore chore, maintenance, etc. size/s Small

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@matthiasbruns @fabianburth @jakobmoellerdev