https://github.com/afiore/cikit
Minimum viable CI reporting
https://github.com/afiore/cikit
Last synced: about 2 months ago
JSON representation
Minimum viable CI reporting
- Host: GitHub
- URL: https://github.com/afiore/cikit
- Owner: afiore
- Created: 2020-06-22T10:26:06.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-20T22:41:49.000Z (over 3 years ago)
- Last Synced: 2026-01-01T21:50:55.992Z (5 months ago)
- Language: Rust
- Homepage:
- Size: 11.9 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## CI Kit
Playground project using Rust to build a minimum viable CI reporting tool.
### Goals
- Provide a minimal but functional UI to display JUnit test reports both through the CLI and as an HTML document.
- Notify test outcome through various channels: i.e. slack web-hooks, github comments/annotations, email, etc.
- Have fun!
### Features
A rudimentary React-based HTML viewer is already implemented:
_Note:_ in order to view the generated reports, you will need to run a webserver using the `report` folder as the document root (e.g `cd report && python2 -m SimpleHTTPServer 8000`).
Also, reports can be rendered in the console using the even more crude _text_ format:
### Usage
```
cikit 0.1.0
The continuous integration reporting toolkit
USAGE:
cikit --config-path [project-dir]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-c, --config-path Input file
ARGS:
SUBCOMMANDS:
help Prints this message or the help of the given subcommand(s)
notify Notifies the build outcome via Slack
test-report Reads the Junit test report
```
### Building and running
In order to statically embed a small set of web assets into its executable, `cikit`
wraps its UI build (React/TypeScript) into a Cargo build.
Assuming you have both `npm` and `rustup` (default toolchain) installed, you should be able to build the project in one go by simply running:
`cargo build`
and then
`cargo test` to execute the test suite.
Finally, you can iteratively recompile and run the program by prefixing the normal executable call with `cargo run --`:
```bash
RUST_LOG='cikit=debug' RUST_BACKTRACE=1 cargo run -- \
-c sample.config.toml ~/code/project-with-junit \
test-report html -o test-report -f
```
You might want to amend the `report_dir_pattern` config value with a glob expression that matches your project junit XML report dir/s.
### Development status
😴 This project is currently in a dormant state and is not being actively maintained.