minikube/cmd/performance/mkcmp/cmd
Steven Powell 4d32230e3e fix lint errors 2024-02-12 17:32:14 -08:00
..
README.md prbot need a strike 2022-06-27 09:50:27 +08:00
mkcmp.go fix lint errors 2024-02-12 17:32:14 -08:00

README.md

mkcmp

mkcmp (“minikube compare”) is a binary to compare the performance of two minikbue binaries. It takes in two minikube binaries, runs minikube start 3 times with each, and then outputs a comparison table in Markdown.

mkcmp takes in references to minikube binaries in two ways:

  1. Direct path to a minikube binary
  2. Reference to a PR number via pr://<PR number>, which will use the binary built at that PR

Sample usage:

make out/mkcmp
# Compare local minikube binary with binary built at PR 400
./out/mkcmp ./out/minikube pr://400

mkcmp is primarily used for our pr-bot, which comments mkcmp output on valid PRs example. To make changes to the pr-bot output, submitting a PR to change mkcmp code should be sufficient.

Note: STDOUT from mkcmp is exactly what is commented on github, so we want it to be in Markdown.