Skip to content

make 'results' subcommand more useful #102

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 9 commits into from
Jan 23, 2025
Merged

make 'results' subcommand more useful #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a26f9e2
Remove leftover script for subcommands
padovan Jan 20, 2025
1d90899
results: use new Dashboard API endpoints to fetch results
padovan Jan 20, 2025
a560798
results: rename tree_list fetch function
padovan Jan 20, 2025
bc2854b
results: add boots subcommand
padovan Jan 20, 2025
2176302
results: add test subcommand
padovan Jan 20, 2025
55438c4
results: add hardware filter for boots and tests
padovan Jan 21, 2025
c62d11b
results: fix download logs for boots and tests
padovan Jan 21, 2025
0a749df
docs: Improve descriptions for the results command
padovan Jan 21, 2025
ff21ab0
results: Add link to the dashboard for results details
padovan Jan 21, 2025
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
45 changes: 41 additions & 4 deletions docs/results.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,34 @@ kci-dev results summary --giturl 'https://git.kernel.org/pub/scm/linux/kernel/gi

### builds

List builds.
List builds results.

Example:

```sh
kci-dev results builds --giturl 'https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git' --branch master --commit d1486dca38afd08ca279ae94eb3a397f10737824
```

### boots

List boot results.

Example:

```sh
kci-dev results boots --giturl 'https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git' --branch master --latest
```

### tests

List test results.

Example:

```sh
kci-dev results tests --giturl 'https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git' --branch master --commit d1486dca38afd08ca279ae94eb3a397f10737824
```

## Common parameters

### --origin
Expand Down Expand Up @@ -74,7 +94,7 @@ kci-dev results builds --giturl 'https://git.kernel.org/pub/scm/linux/kernel/git
### --status

Filter results by the status: "all", "pass", "fail" or "inconclusive".
(available for subcommand `build`)
(available for subcommands `build`, `boots` and `tests`)

Example:
```sh
Expand All @@ -84,13 +104,30 @@ kci-dev results builds --giturl 'https://git.kernel.org/pub/scm/linux/kernel/git
## --download-logs

Automatically download logs for results listed.
(available for subcommand `build`)
(available for subcommands `build`, `boots` and `tests`)

Example:
```sh
kci-dev results build --giturl 'https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git' --branch master --commit d1486dca38afd08ca279ae94eb3a397f10737824 --download-logs
kci-dev results builds --giturl 'https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git' --branch master --commit d1486dca38afd08ca279ae94eb3a397f10737824 --download-logs
```

## --filter

Pass a YAML filter file to customize results. Only supports hardware filtering at the moment.
See filter yaml example below:
(available for subcommands `boots` and `tests`)

```yaml
hardware:
- radxa,rock2-square
- fsl,imx6q
- dell-latitude-3445-7520c-skyrim
```

Example:
```sh
kci-dev results boots --giturl 'https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git' --branch master --latest --filter=filter.yaml
```

### without arguments

Expand Down
Loading
Loading