Skip to content

docs/results: Update documentation #82

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 2 commits into from
Jan 17, 2025
Merged

docs/results: Update documentation #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c1bb66
docs/results: Update documentation
aliceinwire Jan 16, 2025
3509956
pyproject: Update package description
aliceinwire Jan 17, 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
43 changes: 42 additions & 1 deletion docs/results.md
View file
Open in desktop
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

If used without arguments, `kci-dev results` will get KernelCI status of local checked out git repository
In the following example, kci-dev is used on a 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
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tool.poetry]
name = "kci-dev"
version = "0.1.1"
description = "Stand alone tool for Linux Kernel developers and maintainers that can test local Linux Kernel changes on a enabled KernelCI server"
description = "Stand alone tool for Linux Kernel developers and maintainers to interact with KernelCI"
authors = ["Arisu Tachibana <arisu.tachibana@miraclelinux.com>"]
license = "LGPL-2.1-or-later"
readme = "README.md"
Expand Down
Loading