Skip to content

Conversation

@michaelryanpeter
Copy link
Contributor

@michaelryanpeter michaelryanpeter commented Sep 4, 2024

Closes #744

@perdasilva: I am not sure if you are using this file as part of your work. I just wanted to make sure we aren't stepping on each other's toes :)

Description

Reviewer Checklist

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

@michaelryanpeter michaelryanpeter requested a review from a team as a code owner September 4, 2024 18:57
@netlify
Copy link

netlify bot commented Sep 4, 2024

Deploy Preview for olmv1 ready!

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

@michaelryanpeter michaelryanpeter force-pushed the issue-744-document-support-for-skip-ranges-and-replacements branch from 498792d to ae1bcea Compare September 4, 2024 19:00
@codecov
Copy link

codecov bot commented Sep 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.56%. Comparing base (5800c7f) to head (ae1bcea).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1215   +/-   ##
=======================================
  Coverage   77.56%   77.56%           
=======================================
  Files          36       36           
  Lines        1979     1979           
=======================================
  Hits         1535     1535           
  Misses        309      309           
  Partials      135      135           
Flag Coverage Δ
e2e 57.65% <ø> (ø)
unit 56.13% <ø> (ø)

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.

Comment on lines +41 to +46
installNamespace: <namespace>
packageName: <package_name>
serviceAccount:
name: <service_account>
upgradeConstraintPolicy: Ignore
version: "<version_or_version_range>"
Copy link
Member

@joelanford joelanford Sep 4, 2024

Choose a reason for hiding this comment

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

Non-blocking (I think we'll need to sweep the entire repo once all the API changes are finished): All these fields are getting moved around:

Copy link
Contributor Author

@michaelryanpeter michaelryanpeter Sep 4, 2024

Choose a reason for hiding this comment

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

With Material MK Docs, we can actually embed YAML files into a markdown file.

Maybe we can create an issue right before or after 1.0.0 GA to switch our inline examples to embedded YAML files? That way we can update our examples all in one go.

Copy link
Contributor Author

@michaelryanpeter michaelryanpeter Sep 4, 2024

Choose a reason for hiding this comment

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

It looks like #1200 has the relevant doc changes already queued up.

Copy link
Member

Choose a reason for hiding this comment

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

#1200 merged, which makes this section incorrect if it merges. I'm happy to merge this and fix in a follow up (hence my approval on the PR), but I'll defer to you if you want to go ahead and fix now.

Comment on lines +51 to +54
`Ignore`
: Does not limit the next version to the set of successors, and instead allows for any downgrade, sidegrade, or upgrade.

`Enforce`
Copy link
Member

Choose a reason for hiding this comment

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

Another upcoming change: #1151

Copy link
Contributor Author

@michaelryanpeter michaelryanpeter Sep 4, 2024

Choose a reason for hiding this comment

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

@joelanford Do you want to change to the new value now? Or should we to update #1151 with a comment or a docs issue?

Copy link
Member

Choose a reason for hiding this comment

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

Use what you have, which is what is on main. The PR for that change should hopefully find/replace these.

@tmshort tmshort added this pull request to the merge queue Sep 5, 2024
Merged via the queue into operator-framework:main with commit 6cded33 Sep 5, 2024
@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: Implement full support for replaces, skips, and skipRange (and make default)

3 participants