Skip to content

mark principal and issuer class under pkg/identity as deprecated#1980

Merged
Hayden-IO merged 3 commits intosigstore:mainfrom
heysujal:main
Apr 3, 2025
Merged

mark principal and issuer class under pkg/identity as deprecated#1980
Hayden-IO merged 3 commits intosigstore:mainfrom
heysujal:main

Conversation

@heysujal
Copy link
Contributor

Summary

Closes #1798

Release Note

Added Deprecation warning for Principal and Issuer class under pkg/identity as suggested here

#1798 (comment)

Documentation

I think it requires adding a documentation.

Signed-off-by: Sujal Gupta <sujalgupta6100@gmail.com>
@heysujal heysujal requested a review from a team as a code owner March 24, 2025 19:30
@bobcallaway
Copy link
Member

LGTM, I'd like @haydentherapper to take a look when he's back.

Copy link
Contributor

@Hayden-IO Hayden-IO left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
@heysujal
Copy link
Contributor Author

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.

@heysujal heysujal requested a review from Hayden-IO March 30, 2025 13:59
Hayden-IO
Hayden-IO previously approved these changes Mar 30, 2025
@Hayden-IO Hayden-IO enabled auto-merge (squash) March 30, 2025 16:19
@codecov
Copy link

codecov bot commented Mar 30, 2025

Codecov Report

Attention: Patch coverage is 57.14286% with 3 lines in your changes missing coverage. Please review.

Project coverage is 43.62%. Comparing base (cf238ac) to head (6b13035).
Report is 326 commits behind head on main.

Files with missing lines Patch % Lines
pkg/challenges/challenges.go 0.00% 3 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@Hayden-IO
Copy link
Contributor

You'll need to add some comments to have the linter ignore where we still use the deprecated methods.

auto-merge was automatically disabled April 3, 2025 19:04

Head branch was pushed to by a user without write access

Signed-off-by: Sujal Gupta <sujalgupta6100@gmail.com>
@Hayden-IO Hayden-IO enabled auto-merge (squash) April 3, 2025 19:15
@Hayden-IO Hayden-IO merged commit 7342c97 into sigstore:main Apr 3, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants