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.

Sign up for GitHub

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
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion libs/docs/src/docs/no-version/library.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ for teams to collaborate across shared projects.

## Procedure

- Parse a devfile by running:
- Parse a devfile with the code below.
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.
If it is a directory containing several files, the parser will try to discover a devfile based on the following file name priority order:
`devfile.yaml` > `.devfile.yaml` > `devfile.yml` > `.devfile.yml`.

```go
// ParserArgs is the struct to pass into parser functions
Expand Down