fix: add deprecation notice to SourceType field in ApplicationStatus#27767
Open
Shreya2005-2005 wants to merge 2 commits intoargoproj:masterfrom
Open
fix: add deprecation notice to SourceType field in ApplicationStatus#27767Shreya2005-2005 wants to merge 2 commits intoargoproj:masterfrom
Shreya2005-2005 wants to merge 2 commits intoargoproj:masterfrom
Conversation
✅ Preview Environment deployed on Bunnyshell
See: Environment Details | Pipeline Logs Available commands (reply to this comment):
|
SourceType (singular string) and SourceTypes (plural array) both exist in ApplicationStatus with no guidance on which to use. Add deprecation comment to SourceType pointing to SourceTypes, consistent with how ObservedAt deprecation is documented in the same struct. Fixes argoproj#27766 Signed-off-by: Shreya2005-2005 <bhakatmistu@email.com>
Shreya2005-2005
force-pushed
the
fix/sourcetype-deprecation-comment
branch
from
370d980 to
5f355e5
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #27767 +/- ##
==========================================
+ Coverage 63.96% 63.98% +0.02%
==========================================
Files 421 421
Lines 57774 57774
==========================================
+ Hits 36954 36967 +13
+ Misses 17339 17327 -12
+ Partials 3481 3480 -1 ☔ View full report in Codecov by Sentry. |
Update generated.proto, openapi_generated.go and assets/swagger.json to reflect the deprecation comment added to SourceType field in types.go Signed-off-by: Shreya2005-2005 <bhakatmistu@email.com>
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
1 participant
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.
Summary
Adds a deprecation comment to the
SourceTypefield inApplicationStatus, pointing users and tooling authors to useSourceTypesinstead.Problem
Both
status.sourceType(singular string) andstatus.sourceTypes(plural array) exist in the Application CRD with no guidance on which to use. This causes confusion for tooling developers — for example, argocd-image-updater breaks on multi-source apps because it readssourceType(singular) and finds it empty, whilesourceTypes(plural) contains the actual data.Fixes #27766
Fix
Added a deprecation comment to
SourceTypeintypes.go, consistent with howObservedAtdeprecation is already documented in the same struct.Checklist
status.sourceType(singular) andstatus.sourceTypes(plural) with no deprecation notice on the redundant field #27766" in the description