Skip to content

Commit 68544b7

Browse files
authored
Update opm-tooling.md
1 parent aabc493 commit 68544b7

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/design/opm-tooling.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,15 +124,17 @@ In an effort to make channel head selection understandable and deterministic whe
124124

125125
1. Add bundles to the underlying data store
126126
2. Choose the channel heads and default channel
127-
3. Rebuild the update graph starting at the new heads
128-
129-
Channel head -- the "latest" operator in a channel -- selection is now informed by [semver](https://semver.org/). The heurstic is simple, the bundle with the highest version in each channel becomes the new head. The default channel is then taken from the maximum versioned bundle which defines a default channel.
127+
3. Rebuild the update graph starting at the new heads
128+
<br />
129+
Channel head -- the "latest" operator in a channel -- selection is now informed by [semver](https://semver.org/). The heurstic is that the bundle with the highest version in each channel becomes the new head. The default channel is then taken from the maximum versioned bundle which defines a default channel.
130130

131131
Starting from these heads, opm then rebuilds the entire update graph using the edges defined by the `replaces` and `skips` CSV fields.
132132

133-
If a given CSV is missing a version field, all CSVs (sourced from the command's arguments) belonging package are elided from the input. Additionally, a non-zero exit code is returned from the command.
134-
CSVs without a version (and with duplicate versions) that are already part of the index are allowed so long as there is at least one CSV with a version field in the package that we can recognize as having the maximum version.
135-
When `--overwrite-latest` is set, all bundle in a package are deleted and passed in as "input", and thus are constrained by the rules set out in the first paragraph above; the exceptions set out in the second paragraph above do not apply, and violations cause the offending package to be excluded from the index.
133+
If a given CSV is missing a version field, the command ignores all CSVs (sourced from the command's arguments) belonging to that package and exits with a non-zero status code.
134+
135+
CSVs without a version (and with duplicate versions) that are *already part of the index* are allowed so long as there is at least one CSV with a version field in the package that is recognizable as having the maximum version.
136+
137+
When `--overwrite-latest` is set, all existing bundles in a package are processed as new "input", and are thus constrained by the rules for new bundles with no exception for previously-existing unversioned/duplicatively-versioned CSVs, and any offending package in input will be excluded from the resulting index.
136138

137139
#### What does this mean for a package author?
138140

0 commit comments

Comments
 (0)