-
Notifications
You must be signed in to change notification settings - Fork 261
(feature) arbitrary base-version specification for mermaid upgrade-graph output #1013
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
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: grokspawn The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
5aca348 to
5ecc68e
Compare
Codecov Report
@@ Coverage Diff @@
## master #1013 +/- ##
==========================================
- Coverage 51.78% 51.67% -0.11%
==========================================
Files 102 102
Lines 9105 9153 +48
==========================================
+ Hits 4715 4730 +15
- Misses 3488 3515 +27
- Partials 902 908 +6
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
9076f5e to
3d488f2
Compare
|
Going back to WIP to consider an alternative implementation approach Joe and I discussed out-of-band. |
|
This PR describes it two different ways: specify a "base version" or specify a "start version", but I'm still not clear on what's being specified. Could you attach one of the created images here maybe that will make it clear? |
3b1f14b to
ceefbf5
Compare
Oh okay the minimum-edge terminology and explanation make me understand what's going on much better now. |
ceefbf5 to
95e1936
Compare
…ts a different use-case than "generate valid file-based-catalog of X" provide the ability to specify a minimum-edge-name to filter out edges below the version of interest Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
95e1936 to
df2ec23
Compare
|
/lgtm |
Description of the change:
In recognition of the "bolted on" nature of the previous work, this PR moves the command to a standalone
opm alpha render-graphcommand with a--minimum-edgeoption to constrain the output.Motivation for the change:
There has been increasing friction with the
opm renderinfrastructure and the seemingly-orthogonal desire to express an upgrade graph in mermaid format.This came to a crisis when implementing the ability to specify a minimum-edge-name capability to filter out earlier edges from the graph.
** Examples **
*** Full index graph ***
./bin/opm alpha render-graph quay.io/jordankeister/cool-catalog:v1.24.0gives the entire upgrade graph in the catalog*** Minimum-edge graph ***
./bin/opm alpha render-graph quay.io/jordankeister/cool-catalog:v1.24.0 --minimum-edge testoperator.v0.3.0expresses the upgrade graph starting at the minimum edge and including all higher-versioned edges*** Use with file-based-catalog ***
With a catalog or operator contribution in FBC format in a local directory /tmp/catalog (file-based-catalogs are always an arbitrary directory hierarchy)
./bin/opm alpha render-graph /tmp/catalogwill render the entire graph of all channels/operators expressed in the FBC.*** Restricting graphs to a single operator ***
This is outside the scope of this PR, but can be performed in a variety of ways, for e.g.:
opm migrate <indexRef> <outputDir>will generate discrete output directories for each operatoropm renderof an index, withyqmagic to extract only the operator of interest, like:Reviewer Checklist
/docs