ci-reporter: port ci-signal-reporter to k8s.io/release

- Ports state of the repository from https://github.com/alenkacz/ci-signal-report at alenkacz/ci-signal-report@0ab843f - Provides attribution to original authors of the code in this commit in order of commit history - Fixes lint issues in code - Adds copyright header to report.go Commits picked from the above repository: 0ab843f Adding LICENSE file e13b901 Merge pull request #1 from leonardpahlke/update-packaging 21d9d0c update packageing d1c99b8 update structure cf4595d Merge pull request #11 from mkorbi/report-v2 fbf55fb add -short, make version optional, change order of output e1b0a29 Fix go version, rate limit and add version variabl (#10) eaab27f Merge branch 'master' of github.com:alenkacz/ci-signal-report 513789b 1.17 fixes d3b7b85 Group by issues from the same sig (#9) 37672b7 Fix generated urls (#7) c36df2b Try to set up CI 1ea4d5b Always pick resolved column with highest ID (#6) cfd6d63 A bit polishing on readme 710c6f7 Update README.md (#1) d5eb427 Add token help fe16eaa Merge branch 'master' of github.com:alenkacz/ci-signal-report b6071fe Add 1.16 jobs, sig names improvements 8b755a4 Overview d236bf2 Readme 7fcdea6 Initial implementation Co-authored-by: Alena Varkockova <[email protected]> Co-authored-by: Jim Angel <[email protected]> Co-authored-by: Max <[email protected]> Co-authored-by: Max Körbächer <[email protected]> Signed-off-by: Nabarun Pal <[email protected]>
kubernetes · Nov 9, 2021 · e96222b · e96222b
1 parent 9fe81b2
commit e96222b
Show file tree

Hide file tree

Showing 4 changed files with 473 additions and 1 deletion.
diff --git a/cmd/ci-reporter/README.md b/cmd/ci-reporter/README.md
@@ -0,0 +1,105 @@
+# CI signal report
+
+You can get the current overview for CI signal report by running
+
+```
+GITHUB_AUTH_TOKEN=xxx go run report.go
+```
+
+It needs a GitHub token to be able to query the project board for CI signal. For some reason even though those boards are available for public view, the APIs require auth. See [this documentation](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) to set up your access token.
+
+## Prerequisites
+- GoLang >=1.16
+
+## Run the report
+```
+git clone [email protected]:alenkacz/ci-signal-report.git <folder>
+cd <folder>
+GITHUB_AUTH_TOKEN=xxx go run report.go
+```
+
+### Other version statistics
+By adding `RELEASE_VERSION=xxx` where the XXX can be like `1.21`, the report statistics get extended for the choosen version.
+
+```
+GITHUB_AUTH_TOKEN=xxx RELEASE_VERSION=xxx go run report.go
+```
+
+### Short report
+You can also output a short version of the report with the flag `-short`. This reduces the report to `New/Not Yet Started` and `In Flight` issues.
+
+```
+GITHUB_AUTH_TOKEN=xxx go run report.go -short
+```
+
+## Rate limits
+GitHub API has rate limits, to see how much you have used you can query like this (replace User with your GH user and Token with your Auth Token):
+```
+curl \
+  -u GIT_HUB-USER:GIT_HUB_TOKEN -H "Accept: application/vnd.github.v3+json" \
+  https://api.github.com/rate_limit & curl \
+  -H "Accept: application/vnd.github.v3+json" \
+  https://api.github.com/rate_limit
+```
+
+
+## Example output
+```
+GITHUB_AUTH_TOKEN=yourFavouriteGitHubTokenLivesHere RELEASE_VERSION=1.21 go run report.go -short
+
+New/Not Yet Started
+SIG network
+#80719 https://api.github.com/repos/kubernetes/kubernetes/issues/80719 [sig-network] Services should only allow access from service loadbalancer source ranges [Slow]
+
+SIG storage
+#80717 https://api.github.com/repos/kubernetes/kubernetes/issues/80717  [sig-storage] CSI Volumes [Driver: csi-hostpath] Snapshot Tests
+
+In flight
+SIG testing
+#79662 https://api.github.com/repos/kubernetes/kubernetes/issues/79662   Nodes resize test failing in master-blocking
+
+SIG cluster-lifecycle
+#78907 https://api.github.com/repos/kubernetes/kubernetes/issues/78907 [Flaky Tests] task-06-upgrade is failing on master-informing
+
+SIG scheduling
+#74931 https://api.github.com/repos/kubernetes/kubernetes/issues/74931 Scheduler TestPreemptionRaces is flaky
+
+Observing
+SIG apps
+#79740 https://api.github.com/repos/kubernetes/kubernetes/issues/79740  Test Deployment deployment should support rollback is failing on master informing
+
+SIG cli
+#79533 https://api.github.com/repos/kubernetes/kubernetes/issues/79533  Kubectl client Conformance test failing
+
+Resolved
+SIG cluster-lifecycle
+#80434 https://api.github.com/repos/kubernetes/kubernetes/issues/80434  Errors bringing up kube-proxy in CI
+
+Failures in Master-Blocking
+    14 jobs total
+    9 are passing
+    2 are flaking
+    3 are failing
+    0 are stale
+
+Failures in Master-Informing
+    14 jobs total
+    7 are passing
+    4 are flaking
+    3 are failing
+    0 are stale
+
+Failures in 1.21-Blocking
+    14 jobs total
+    9 are passing
+    2 are flaking
+    3 are failing
+    0 are stale
+
+Failures in 1.21-Informing
+    14 jobs total
+    7 are passing
+    4 are flaking
+    3 are failing
+    0 are stale
+ ```