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

error out if import devfile version is greater than child #125

Merged
merged 1 commit into from
Nov 24, 2021

Conversation

yangcao77
Copy link
Collaborator

Signed-off-by: Stephanie yangcao@redhat.com

What does this PR do?:

This PR compares the version of parent/plugin devfile with it's child devfile, and error out if greater than child devfile version.

Which issue(s) this PR fixes:

Fixes devfile/api#686

PR acceptance criteria:

Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.

  • Open new test/doc issues under the devfile/api repo
  • Check each criteria if:
  • There is a separate tracking issue. Add the issue link under the criteria
    or
  • test/doc updates are made as part of this PR
  • If unchecked, explain why it's not needed

How to test changes / Special notes to the reviewer:

Sorry, something went wrong.

Signed-off-by: Stephanie <yangcao@redhat.com>
Copy link
Contributor

@kim-tsao kim-tsao left a comment

Choose a reason for hiding this comment

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

This is outside the PR, but should we open up a doc issue to explain this behaviour?

@openshift-ci
Copy link

openshift-ci bot commented Nov 24, 2021

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kim-tsao, yangcao77

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

@yangcao77
Copy link
Collaborator Author

This is outside the PR, but should we open up a doc issue to explain this behaviour?

I understand the concern, but we currently do not have any doc for the errors. I'm not sure if we want to doc all error behaviors.

@yangcao77 yangcao77 closed this Nov 24, 2021
@yangcao77 yangcao77 reopened this Nov 24, 2021
@kim-tsao
Copy link
Contributor

This is outside the PR, but should we open up a doc issue to explain this behaviour?

I understand the concern, but we currently do not have any doc for the errors. I'm not sure if we want to doc all error behaviors.

I was thinking about having a section for version compatibility wrt to parent/plugin overriding or maybe documenting this as a limitation. Users may assume full interoperability otherwise.

@yangcao77
Copy link
Collaborator Author

I was thinking about having a section for version compatibility wrt to parent/plugin overriding or maybe documenting this as a limitation. Users may assume full interoperability otherwise.

I will merge this PR, and issue created to track the doc change required: devfile/api#694

@yangcao77 yangcao77 merged commit 5a5cbcc into devfile:main Nov 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Library need to check and handle the case if parent devfile is with a different schema version
2 participants