Skip to content
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

Add properties.yaml to dependencies #227

Merged
merged 2 commits into from
Mar 9, 2022

Conversation

cdjohnson
Copy link
Contributor

Fixes: operator-framework/operator-registry#912

I also fixed the comments about the version of OPM and OLM that is required for dependencies.yaml and properties.yaml. This is based off of looking the commits for these PRs.

Fixes: operator-framework/operator-registry#912

I also fixed the comments about the version of **OPM** and **OLM** that is required for dependencies.yaml and properties.yaml and
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 31, 2022
@openshift-ci openshift-ci bot requested review from exdx and njhale January 31, 2022 21:27
Fix OPM version for dependencies.yaml.
@cdjohnson cdjohnson changed the title WIP: Add properties.yaml to dependencies Add properties.yaml to dependencies Feb 2, 2022
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 2, 2022
@timflannagan
Copy link
Contributor

@joelanford @dinhxuanvu Have been closer to this domain than I have, so it might be worth getting sign off from them before we merge.

Copy link
Member

@dinhxuanvu dinhxuanvu left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 3, 2022
@cdjohnson
Copy link
Contributor Author

/assign @anik120

@timflannagan
Copy link
Contributor

/cc @perdasilva @joelanford it looks like this is ready to go imo and only needs an approval at this point.

Copy link
Member

@dinhxuanvu dinhxuanvu left a comment

Choose a reason for hiding this comment

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

/approve

@dinhxuanvu
Copy link
Member

@anik120 Can you approve this PR? Thanks.

Copy link
Contributor

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

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

/lgtm

- `dependencies.yaml` file
- `properties.yaml` file (supported by `1.17.4+ versions of OPM)

Each of these files can be included in the `metadata` directory of the operator bundle. For more information on bundles and the their format, see the [bundle docs](https://github.com/operator-framework/operator-registry/blob/master/docs/design/operator-bundle.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

would be nice at some point we have this doc on the olm website.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I assume once this is merged, it will show up here:
https://olm.operatorframework.io/docs/concepts/olm-architecture/dependency-resolution/

Isn't this the "OLM website"?

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't believe we have documentation around the OLM bundle format (e.g. registry+v1) on the official OLM documentation site, so we always reference the documentation that lives in the operator-registry repository as the source of truth. I think Camila was alluding to mirroring that operator-bundle.md documentation to the olm.operatorframework.io website, so we can have all documentation under one roof, vs. scattered throughout multiple repositories.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Probably tie into this:
#187

@anik120
Copy link
Collaborator

anik120 commented Mar 9, 2022

/approve

@openshift-ci
Copy link

openshift-ci bot commented Mar 9, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: anik120, cdjohnson, dinhxuanvu

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 9, 2022
@openshift-merge-robot openshift-merge-robot merged commit 27419f5 into operator-framework:master Mar 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clearly promote properties.yaml and start deprecation of dependencies.yaml
6 participants