mark principal and issuer class under pkg/identity as deprecated#1980
mark principal and issuer class under pkg/identity as deprecated#1980Hayden-IO merged 3 commits intosigstore:mainfrom
Conversation
Signed-off-by: Sujal Gupta <sujalgupta6100@gmail.com>
| LGTM, I'd like @haydentherapper to take a look when he's back. |
Hayden-IO left a comment
There was a problem hiding this comment.
Thanks for working on this. These interfaces are not deprecated though. The comment in the linked issue was for deprecating the issuer and principal structs under https://github.com/sigstore/fulcio/tree/main/pkg/identity/codefresh, https://github.com/sigstore/fulcio/tree/main/pkg/identity/buildkite, https://github.com/sigstore/fulcio/tree/main/pkg/identity/gitlabcom, and https://github.com/sigstore/fulcio/tree/main/pkg/identity/github.
I would mark any publicly exported method/struct as deprecated and link to the respective method/struct under https://github.com/sigstore/fulcio/blob/main/pkg/identity/ciprovider/.
Signed-off-by: Sujal Gupta <sujalgupta6100@gmail.com>
| I have a query that all the structs under the mentioned directories like github and gitlab etc are non-public. Then ideally I shouldn't have marked them as deprecated but then what structs need to marked as deprecated. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@ ## main #1980 +/- ## =========================================== - Coverage 57.93% 43.62% -14.32% =========================================== Files 50 73 +23 Lines 3119 5724 +2605 =========================================== + Hits 1807 2497 +690 - Misses 1154 2997 +1843 - Partials 158 230 +72 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| You'll need to add some comments to have the linter ignore where we still use the deprecated methods. |
Head branch was pushed to by a user without write access
Signed-off-by: Sujal Gupta <sujalgupta6100@gmail.com>
Summary
Closes #1798
Release Note
Added Deprecation warning for Principal and Issuer class under
pkg/identityas suggested here#1798 (comment)
Documentation
I think it requires adding a documentation.