Clarification on the .yml extension

[rli]

/area documentation

Which area this documentation change is related to?

/area library

Issue details

What mistake did you find / what is missing in the documentation?

The devfile library only supports devfile.yaml and .devfile.yaml.

Though the YAML FAQ states that .yaml extension is preferred, .yml is frequently accepted as a valid alternative.

Is there a reason why .yml isn't valid, or was this simply an oversight?

[elsony]

It should also allow devfiles with:

1. .json formatted devfiles
2. .yml extension
3. Not restricting the devfile filename other than devfile.yaml, e.g. mydevfile.yaml

[elsony]

This item involves more than the documentation changes. It will require:

1. Update the library logic to accept devfile.yml and .devfile.yml
2. Add test cases for looking for devfile.yml and .devfile.yml
3. Work with the tools to look for files with .yml extension when discovering the devfile within an application

[rm3l]

This has been fixed recently with #1265. The devfile library now supports parsing any file it is provided (regardless of its name and extension, as long as it is parsable).
Additionally, in places where a devfile is discovered (e.g., when clients provide a directory as path to the parser), the library will try to pick a devfile based on the following priority order: devfile.yaml > .devfile.yaml > devfile.yml > .devfile.yml
The documentation has also been updated accordingly: https://devfile.io/docs/2.2.1/library#procedure

/close

[openshift-ci]

@rm3l: Closing this issue.

In response to this:

This has been fixed recently with #1265. The devfile library now supports parsing any file it is provided (regardless of its name and extension, as long as it is parsable).
Additionally, in places where a devfile is discovered (e.g., when clients provide a directory as path to the parser), the library will try to pick a devfile based on the following priority order: devfile.yaml > .devfile.yaml > devfile.yml > .devfile.yml
The documentation has also been updated accordingly: https://devfile.io/docs/2.2.1/library#procedure

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.