diff mbox series

[02/12] patch-status: add README.md file

Message ID 20240513145905.4167-3-ninette@thehoodiefirm.com
State New
Headers show
Series M12: Improve the Charts in the Metrics View | expand

Commit Message

Ninette Adhikari May 13, 2024, 2:58 p.m. UTC 
From: Alex Feyerke <hello@alexfeyerke.com>

Add information on running locally for development, including generating test data from yocto-autobuilder-helper.

Signed-off-by: Ninette Adhikari <ninette@thehoodiefirm.com>
---
 README | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 README
diff mbox series

Patch

diff --git a/README b/README
new file mode 100644
index 00000000..ac2ee186
--- /dev/null
+++ b/README
@@ -0,0 +1,64 @@ 
+# yocto-metrics
+Yocto Project autobuilder gathered metrics, CVEs etc.
+
+## Local setup
+1. Clone repositories
+
+  Clone both the report and data repo:
+
+  ```sh
+  # clone yocto-autobuilder-helper
+  git clone git://git.yoctoproject.org/yocto-autobuilder-helper.git
+
+  # clone yocto-metrics
+  git clone git://git.yoctoproject.org/yocto-metrics
+  ```
+
+2. Generate chart data
+  At first we have to generate the necessary data for the charts.
+  For this we have to go the autobuilder repository and generate chart data.
+
+  Go to your local clone of the autobuilder repository
+  Then run the following to generate the data and save it in your local yocto-metrics/patch-status directory:
+
+  _Possibly you have to adapt your local path to yocto-metrics._
+  ```sh
+  cd yocto-autobuilder-helper
+  ./scripts/patchmetrics-generate-chartdata --json "../yocto-metrics/patch-status.json" --outputdir "../yocto-metrics/patch-status/"
+  ```
+
+3. Generate CVE report data
+  We need to generate CVE report data for each branch.
+  The following is an example showing data generated for the master branch.
+  You will need to run this for _every branch you need CVE data_ for.
+
+