3d0303a57c
The current tool is a shell script that mixes data collection and HTML generation and is generally a pain to work with. It takes 15 minutes to run. The new tool is written in go, collects all data first, then generates the output HTML from the data and a single template, and finishes in 10 seconds. The goal in this version is to produce output as similar as possible to the output of the shell script. Some difference will remain because the shell script returns some trash data whose reproduction would require more effort than is worth. Change-Id: I4fab86d24088e4f9eff434c21ce9caa077f3f9e2 Signed-off-by: Patrick Georgi <pgeorgi@google.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/59958 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Maxim Polyakov <max.senia.poliak@gmail.com> |
||
---|---|---|
.. | ||
templates | ||
boards.go | ||
bucketize.sh | ||
foreword.html | ||
go.mod | ||
go.sum | ||
logs.go | ||
README | ||
status-to-html.go | ||
status-to-html.sh | ||
tohtml.sh | ||
types.go |
Scripts to publish board-status data to the wiki ================================================ These scripts parse the board-status repository (and the coreboot repository as companion) to build a meaningful representation of the test coverage stored in board-status. The server runs these nightly (CET/CEST), so no user interaction with the wiki page is needed. How to use ---------- When modifying the scripts, or when publishing the results elsewhere, you might want to run them yourself. You'll need the board-status and the coreboot repository checked out side by side, named "board-status" and "coreboot" respectively (in particular without .git suffix). To emit wiki-text, in the board-status repository's top-level directory, run $ ../util/board_status/to-wiki/status-to-wiki.sh The output ends up on stdout, so you'll have to store it yourself, if you need it later. `push-to-wiki.sh FILENAME TITLE` can be used to push a file into the wiki. User credentials are looked up in ~/.wikiaccount, which should look like USERNAME=user USERPASS=password How it works ------------ status-to-wiki collects the reports and sorts them in buckets by report date. These can have weekly, monthly and quarterly granularity. It then passes these into the towiki script, which reads the data in more details and prints them in the output format. Contributions ------------- These scripts are rather bare, and you're welcome to extend them to extract more useful data from both repositories, and to present the data in a nicer way. A rewrite into another (reasonable) language is fine, too - shell quickly finds its limits for this kind of text processing.