Skip to content

Commit b2a6b0e

Browse files
committed
Document priority order behavior of library parser when parsing directory with multiple filename variants of a devfile
Signed-off-by: Armel Soro <[email protected]>
1 parent 0b89f91 commit b2a6b0e

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

libs/docs/src/docs/no-version/library.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ for teams to collaborate across shared projects.
99

1010
## Procedure
1111

12-
- Parse a devfile by running:
12+
- Parse a devfile with the code below.
13+
Note that the `Path` field in the `parser.ParserArgs` struct can be a relative or absolute path to any file or directory on the filesystem.
14+
If it is a directory containing several files, the parser will try to discover a devfile based on the following file name priority order:
15+
`devfile.yaml` > `.devfile.yaml` > `devfile.yml` > `.devfile.yml`.
1316

1417
```go
1518
// ParserArgs is the struct to pass into parser functions

0 commit comments

Comments
 (0)