Skip to content

📖[Docs] How-to: Z-stream Automatic Updates #1219

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

Conversation

perdasilva
Copy link
Contributor

@perdasilva perdasilva commented Sep 5, 2024

Description

Closes #1128

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

@perdasilva perdasilva requested a review from a team as a code owner September 5, 2024 15:31
Copy link

netlify bot commented Sep 5, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit d10752e
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/66dab634f8e24400083753e1
😎 Deploy Preview https://deploy-preview-1219--olmv1.netlify.app
📱 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.

Copy link

codecov bot commented Sep 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.49%. Comparing base (c4470cc) to head (d10752e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1219      +/-   ##
==========================================
- Coverage   76.53%   76.49%   -0.05%     
==========================================
  Files          40       40              
  Lines        2340     2340              
==========================================
- Hits         1791     1790       -1     
- Misses        392      393       +1     
  Partials      157      157              
Flag Coverage Δ
e2e 57.64% <ø> (ø)
unit 52.43% <ø> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

sourceType: Catalog
catalog:
packageName: argocd-operator
version: “~2.3" # Automatically upgrade patch releases for v2.3
Copy link
Contributor

Choose a reason for hiding this comment

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

is 2.3.x equivalent to this?

Should we document all the semantic ways to achieve "z-stream automatic updates"?

Copy link
Member

Choose a reason for hiding this comment

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

I don't think we need to document the synonyms for a particular version range. I think one example is sufficient here. The API reference will document all the ways.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, that was my thought process as well. I think it's best to give folks one way of doing things (even if there are multiple - and document that elsewhere). Options lead to stress XD - having said that, is 2.3.x prettier?

Copy link
Contributor

Choose a reason for hiding this comment

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

i think ~2.3 is fine. it's 1 character shorter :P

Signed-off-by: Per Goncalves da Silva <[email protected]>
@perdasilva perdasilva force-pushed the perdasilva/docs/howto-z-stream-upgd branch from 3bd28c3 to d10752e Compare September 6, 2024 07:58
@everettraven everettraven added this pull request to the merge queue Sep 6, 2024
Merged via the queue into operator-framework:main with commit 9c6d4ce Sep 6, 2024
17 of 18 checks passed
@skattoju skattoju mentioned this pull request Sep 25, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Accept automatic upgrades within a specific z-stream
3 participants