Skip to content

Document the behavior of the devfile library when parsing a directory containing multiple devfiles #106

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

Merged
merged 1 commit into from
Nov 2, 2023

Conversation

rm3l
Copy link
Member

@rm3l rm3l commented Nov 2, 2023

What does this PR do / why we need it

This is a follow-up PR to devfile/library#186.
It makes sure to document the behavior of the library when the parser is provided a directory path containing multiple filename variants of a devfile, in particular the priority order in which a devfile is determined and picked.

Which issue(s) does this PR fix

Fixes devfile/api#1265

PR acceptance criteria

  • Unit Tests
  • E2E Tests
  • Documentation
    Update the sidebar if there is a new file added or an existing filename is changed

How to test changes / Special notes to the reviewer

…tory with multiple filename variants of a devfile

Signed-off-by: Armel Soro <[email protected]>
@openshift-ci openshift-ci bot requested review from elsony and thepetk November 2, 2023 11:47
@openshift-ci openshift-ci bot added the approved label Nov 2, 2023
@rm3l rm3l requested a review from yangcao77 November 2, 2023 11:47
@rm3l rm3l changed the title Document behavior of the devfile library when parsing directory with multiple filename variants of a devfile Document the behavior of the devfile library when parsing directory with multiple filename variants of a devfile Nov 2, 2023
@rm3l rm3l changed the title Document the behavior of the devfile library when parsing directory with multiple filename variants of a devfile Document the behavior of the devfile library when parsing a directory with multiple filename variants of a devfile Nov 2, 2023
@rm3l rm3l changed the title Document the behavior of the devfile library when parsing a directory with multiple filename variants of a devfile Document the behavior of the devfile library when parsing a directory containing multiple devfiles. Nov 2, 2023
@rm3l rm3l changed the title Document the behavior of the devfile library when parsing a directory containing multiple devfiles. Document the behavior of the devfile library when parsing a directory containing multiple devfiles Nov 2, 2023
@rm3l rm3l mentioned this pull request Nov 2, 2023
6 tasks
Copy link
Contributor

@thepetk thepetk left a comment

Choose a reason for hiding this comment

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

/lgtm

Copy link

openshift-ci bot commented Nov 2, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rm3l, thepetk

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

@rm3l rm3l merged commit b2a6b0e into devfile:main Nov 2, 2023
@rm3l rm3l deleted the 1265-support-.yml-extension--devfile-web branch November 2, 2023 15:55
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.

Support .yml extension
2 participants