channeltypepreference attribute for semver template; providing hyperlinks to example sections #296
Conversation
This file contains 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
…inks to example sections Signed-off-by: Jordan Keister <[email protected]>
5 tasks
|
I opened issue #297 to resolve the new 404s on the advanced topics page causing failures in the linter, so we don't lose track of them. They are not material to these changes, however. |
Signed-off-by: Jordan Keister <[email protected]>
|
|
||
| ```yaml | ||
| GenerateMinorChannels: true | ||
| GenerateMajorChannels: false |
There was a problem hiding this comment.
Based on the surrounding context:
Suggested change
| GenerateMajorChannels: false | |
| GenerateMajorChannels: true |
| @@ -254,6 +254,9 @@ The `olm.semver` [cue](https://cuelang.org/docs/references/spec/) schema is: | |||
| // optional flag to control generating major-version channels, defaults to _false_ if unspecified | |||
| GenerateMajorChannels?: bool | |||
|
|
|||
| // optional flag to prefer major- or minor-version channels, when both are generated and identical in stability and version | |||
| DefaultChannelTypePreference?: bool | |||
There was a problem hiding this comment.
Suggested change
| DefaultChannelTypePreference?: bool | |
| DefaultChannelTypePreference?: string |
Signed-off-by: Jordan Keister <[email protected]>
everettraven
approved these changes
May 24, 2023
| @@ -254,6 +254,9 @@ The `olm.semver` [cue](https://cuelang.org/docs/references/spec/) schema is: | |||
| // optional flag to control generating major-version channels, defaults to _false_ if unspecified | |||
| GenerateMajorChannels?: bool | |||
|
|
|||
| // optional preference for major- or minor-version channels, when both are generated and identical in stability and version | |||
| DefaultChannelTypePreference?: string | |||
There was a problem hiding this comment.
Is there a requirement that this is within a specific set of values or can this be any string value?
There was a problem hiding this comment.
We enforce it in the code to either 'minor' or 'major': https://github.com/operator-framework/operator-registry/blob/master/alpha/template/semver/semver.go#LL95-L112
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Introducing a new semver template attribute which provides authors the capability to deterministically select generated major or minor channels as default when they are for all other measures "equally stable".
This attribute is defaulted to minor-version channels if omitted.
Changes visible in the Catalog Templates page.