Skip to content

Commit

Permalink
docs/results: Update documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Arisu Tachibana <[email protected]>
  • Loading branch information
aliceinwire committed Jan 16, 2025
1 parent 447f0ca commit 3f94021
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion docs/results.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ The url of the tree to fetch results

The branch to get results for

### --git-folder

Path of the local git repository

### --commit

The tip of tree commit being tested. It needs to be the full commit hash.
Expand All @@ -39,12 +43,49 @@ Filter results by the status: "all", "pass", "fail" or "inconclusive"

## Results actions

### --action=trees

List all available trees for a given origin.

Example:

### without arguments

Used without arguments `kci-dev results` will get KernelCI status of local checkout git repository
In the following example kci-dev is used on the local linux repository folder
This command work with every linux repository supported by KernelCI

```sh
linux git:(master)$ kci-dev results
git folder: None
tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
branch: master
commit: fbfd64d25c7af3b8695201ebc85efe90be28c5a3

pass/fail/inconclusive
builds: 46/0/0
boots: 580/48/8
tests: 7858/6903/654
```

### --git-folder=<local repository path>

Get results automatically from a folder with a local linux repository

```sh
kci-dev git:(master)$ kci-dev results --git-folder ../linux
git folder: ../linux
tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
branch: master
commit: fbfd64d25c7af3b8695201ebc85efe90be28c5a3

pass/fail/inconclusive
builds: 46/0/0
boots: 580/48/8
tests: 7858/6903/654
```

### --action=trees

```sh
kci-dev results --action=trees
```
Expand Down

0 comments on commit 3f94021

Please sign in to comment.