Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Long Stage names result in AnalysisRun creation failures during promotion #3520

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

aidan-canva
Copy link
Contributor

Closes #3202

Long Stage names cause errors during promotions due to calculated labels (kargo.akuity.io/promotion) on AnalysisRun resources exceeding the max 63 character limit of a label value.

This solution moves the kargo.akuity.io/promotion label to an annotation which has a much larger max length. It doesn't appear this label key is used for selecting at the moment so its largely an informative value.

An alternative approach to truncate Stage name was considered (with hashing for uniqueness) but that greatly reduces legibility within the UI (IMO). Doing it inconsistently might work, but then impacts ability to debug and map relationships with resources easily.

This solution strikes a middle ground to unblock longer Stage names and give time for a more considered approach to naming/labeling conventions if its required.

@aidan-canva aidan-canva requested a review from a team as a code owner February 19, 2025 07:38
Copy link

netlify bot commented Feb 19, 2025

Deploy Preview for docs-kargo-io ready!

Name Link
🔨 Latest commit bfd66c1
🔍 Latest deploy log https://app.netlify.com/sites/docs-kargo-io/deploys/67b7aa2e2418f700084daa09
😎 Deploy Preview https://deploy-preview-3520.docs.kargo.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

…itting max length issues due to long stage names

Signed-off-by: Aidan Rowe <[email protected]>
@aidan-canva aidan-canva force-pushed the fix-long-stage-names-break-verification branch from e994877 to a1b4010 Compare February 19, 2025 07:44
@hiddeco hiddeco added this to the v1.3.0 milestone Feb 19, 2025
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.43%. Comparing base (e1d2fab) to head (bfd66c1).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3520      +/-   ##
==========================================
+ Coverage   52.27%   52.43%   +0.15%     
==========================================
  Files         290      294       +4     
  Lines       26330    26663     +333     
==========================================
+ Hits        13764    13980     +216     
- Misses      11814    11915     +101     
- Partials      752      768      +16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@krancour
Copy link
Member

Tentatively assigned to v1.3.0, but might be a good candidate to be deferred.

Copy link
Contributor

@hiddeco hiddeco left a comment

Choose a reason for hiding this comment

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

I think docs/docs/50-user-guide/20-how-to-guides/60-verification.md contains a label example that has to be updated.

Signed-off-by: Aidan Rowe <[email protected]>
@aidan-canva aidan-canva requested a review from a team as a code owner February 20, 2025 22:18
@aidan-canva
Copy link
Contributor Author

Thanks @hiddeco, fixed!

@aidan-canva aidan-canva requested a review from hiddeco February 20, 2025 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: Unable to create AnalysisRun due to long Stage name
3 participants