improve mise tasks

zeitlinger · zeitlinger · commit 8d00766b5003 · 2025-11-04T15:22:53.000+01:00
Signed-off-by: Gregor Zeitlinger &lt;gregor.zeitlinger@grafana.com&gt;
diff --git a/.mise/tasks/.shellcheckrc b/.mise/tasks/.shellcheckrc
@@ -0,0 +1,3 @@
+# shellcheck configuration for mise tasks
+# SC2154: usage_* variables are set by mise framework
+disable=SC2154
diff --git a/.mise/tasks/build-release.sh b/.mise/tasks/build-release.sh
@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+#MISE description="Build release package"
+#MISE env={TAG = "1.5.0-SNAPSHOT"}
+
 set -euo pipefail
 
 VERSION=${TAG#v}
diff --git a/.mise/tasks/lint-bom.sh b/.mise/tasks/lint-bom.sh
@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+#MISE description="Make sure the BOM has all necessary modules"
 
 set -euo pipefail
 
diff --git a/.mise/tasks/run-benchmarks.py b/.mise/tasks/run-benchmarks.py
@@ -1,4 +1,7 @@
 #!/usr/bin/env python3
+
+#MISE description="Run and update JMH benchmark outputs in the benchmarks module"
+
 """
 Run benchmarks for the `benchmarks` module, capture JMH text output, and update
 any <pre>...</pre> blocks containing "thrpt" under the `benchmarks/` module
@@ -166,20 +169,6 @@ def main(argv: List[str]):
     parser.add_argument('--jmh-args', default='', help='Extra arguments to pass to the JMH main (e.g. "-f 1 -wi 0 -i 1")')
     args = parser.parse_args(argv)
 
-    # Determine repository root by searching upwards for a marker (mvnw or pom.xml).
-    start_dir = os.path.abspath(os.path.dirname(__file__))
-    repo_root = start_dir
-    while True:
-        if os.path.exists(os.path.join(repo_root, 'mvnw')) or os.path.exists(os.path.join(repo_root, 'pom.xml')):
-            break
-        parent = os.path.dirname(repo_root)
-        if parent == repo_root:
-            # reached filesystem root; fallback to original heuristic (one level up)
-            repo_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))
-            break
-        repo_root = parent
-    os.chdir(repo_root)
-
     build_benchmarks(args.mvnw, args.module)
     jar = find_benchmarks_jar(args.module)
     output = run_jmh(jar, args.java, args.jmh_args)
diff --git a/.mise/tasks/set-release-version-github-pages.sh b/.mise/tasks/set-release-version-github-pages.sh
@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
 
+#MISE description="Set release version in GitHub Pages quickstart.md"
+
 set -euox pipefail
 
 version=$(git tag -l | grep 'v' | sort | tail -1 | sed 's/v//')
diff --git a/.mise/tasks/set-version.sh b/.mise/tasks/set-version.sh
@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+#MISE description="Update version in all pom.xml files"
+#USAGE arg "<version>" help="new version"
+
+set -euo pipefail
+
+# replace all occurrences '<version>1.5.0-SNAPSHOT</version>' with '<version>$usage_version</version>'
+# in all pom.xml files in the current directory and subdirectories
+
+find . -name 'pom.xml' -exec \
+	sed -i "s/<version>1.5.0-SNAPSHOT<\/version>/<version>$usage_version<\/version>/g" {} +
diff --git a/.mise/tasks/super-linter.sh b/.mise/tasks/super-linter.sh
@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
 
+#MISE description="Run GitHub Super Linter on the repository"
+
 set -euo pipefail
 
 pushd "$(dirname "$0")/.."
diff --git a/benchmarks/README.md b/benchmarks/README.md
@@ -1,6 +1,16 @@
 # Benchmarks
 
 ## How to Run
+                               
+### Running benchmarks
+
+Run benchmarks and update the results in the Javadoc of the benchmark classes:
+
+```shell
+mise run run-benchmarks
+``` 
+
+### Running benchmarks manually
 
 ```shell
 java -jar ./benchmarks/target/benchmarks.jar
diff --git a/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/CounterBenchmark.java b/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/CounterBenchmark.java
@@ -21,18 +21,17 @@
  * Results on a machine with dedicated Core i7 1265U:
  *
  * <pre>
- *
- * Benchmark                                     Mode  Cnt      Score     Error  Units
- * CounterBenchmark.codahaleIncNoLabels         thrpt   25  32969.795 ± 1547.775  ops/s
- * CounterBenchmark.openTelemetryAdd            thrpt   25    747.068 ±   93.128  ops/s
- * CounterBenchmark.openTelemetryInc            thrpt   25    760.784 ±   47.595  ops/s
- * CounterBenchmark.openTelemetryIncNoLabels    thrpt   25    824.346 ±   45.131  ops/s
- * CounterBenchmark.prometheusAdd               thrpt   25  28403.000 ±  250.774  ops/s
- * CounterBenchmark.prometheusInc               thrpt   25  38368.142 ±  361.914  ops/s
- * CounterBenchmark.prometheusNoLabelsInc       thrpt   25  35558.069 ± 4020.926  ops/s
- * CounterBenchmark.simpleclientAdd             thrpt   25   4081.152 ±  620.094  ops/s
- * CounterBenchmark.simpleclientInc             thrpt   25   5735.644 ± 1205.329  ops/s
- * CounterBenchmark.simpleclientNoLabelsInc     thrpt   25   6852.563 ±  544.481  ops/s
+ * Benchmark                                             Mode  Cnt       Score   Error  Units
+ * CounterBenchmark.codahaleIncNoLabels                 thrpt        57881.585          ops/s
+ * CounterBenchmark.openTelemetryAdd                    thrpt         9771.577          ops/s
+ * CounterBenchmark.openTelemetryInc                    thrpt         9627.961          ops/s
+ * CounterBenchmark.openTelemetryIncNoLabels            thrpt        10303.562          ops/s
+ * CounterBenchmark.prometheusAdd                       thrpt        31623.420          ops/s
+ * CounterBenchmark.prometheusInc                       thrpt        54090.469          ops/s
+ * CounterBenchmark.prometheusNoLabelsInc               thrpt        50913.426          ops/s
+ * CounterBenchmark.simpleclientAdd                     thrpt         4564.419          ops/s
+ * CounterBenchmark.simpleclientInc                     thrpt         4645.809          ops/s
+ * CounterBenchmark.simpleclientNoLabelsInc             thrpt         4581.249          ops/s
  * </pre>
  *
  * Prometheus counters are faster than counters of other libraries. For example, incrementing a
diff --git a/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/HistogramBenchmark.java b/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/HistogramBenchmark.java
@@ -20,12 +20,12 @@
  * Results on a machine with dedicated Core i7 1265U:
  *
  * <pre>
- * Benchmark                                     Mode  Cnt      Score     Error  Units
- * HistogramBenchmark.openTelemetryClassic      thrpt   25    390.982 ±   16.058  ops/s
- * HistogramBenchmark.openTelemetryExponential  thrpt   25    320.160 ±   18.056  ops/s
- * HistogramBenchmark.prometheusClassic         thrpt   25   2385.862 ±   34.766  ops/s
- * HistogramBenchmark.prometheusNative          thrpt   25   1947.371 ±   48.193  ops/s
- * HistogramBenchmark.simpleclient              thrpt   25   4324.961 ±   50.938  ops/s
+ * Benchmark                                             Mode  Cnt       Score   Error  Units
+ * HistogramBenchmark.openTelemetryClassic              thrpt         6725.610          ops/s
+ * HistogramBenchmark.openTelemetryExponential          thrpt         5280.926          ops/s
+ * HistogramBenchmark.prometheusClassic                 thrpt        14286.384          ops/s
+ * HistogramBenchmark.prometheusNative                  thrpt         2385.134          ops/s
+ * HistogramBenchmark.simpleclient                      thrpt         4062.732          ops/s
  * </pre>
  *
  * The simpleclient (i.e. client_java version 0.16.0 and older) histograms perform about the same as
diff --git a/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/TextFormatUtilBenchmark.java b/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/TextFormatUtilBenchmark.java
@@ -24,11 +24,11 @@
  * Results on a machine with dedicated Ubuntu 24.04 LTS, AMD Ryzen™ 9 7900 × 24, 96.0 GiB RAM:
  *
  * <pre>
- * Benchmark                                             Mode  Cnt       Score       Error  Units
- * TextFormatUtilBenchmark.openMetricsWriteToByteArray  thrpt   25  846397.071 ±  8835.379  ops/s
- * TextFormatUtilBenchmark.openMetricsWriteToNull       thrpt   25  862205.960 ± 14185.181  ops/s
- * TextFormatUtilBenchmark.prometheusWriteToByteArray   thrpt   25  916443.104 ±  7359.549  ops/s
- * TextFormatUtilBenchmark.prometheusWriteToNull        thrpt   25  907473.591 ± 12615.214  ops/s
+ * Benchmark                                             Mode  Cnt       Score   Error  Units
+ * TextFormatUtilBenchmark.openMetricsWriteToByteArray  thrpt       826488.303          ops/s
+ * TextFormatUtilBenchmark.openMetricsWriteToNull       thrpt       826167.112          ops/s
+ * TextFormatUtilBenchmark.prometheusWriteToByteArray   thrpt       886213.786          ops/s
+ * TextFormatUtilBenchmark.prometheusWriteToNull        thrpt       885331.328          ops/s
  * </pre>
  */
 public class TextFormatUtilBenchmark {
diff --git a/mise.toml b/mise.toml
@@ -43,15 +43,10 @@ run = "./mvnw verify"
 description = "build all modules wihthout tests"
 run = "./mvnw install -DskipTests -Dcoverage.skip=true"
 
-[tasks.lint]
-run = "scripts/super-linter.sh"
-
 [tasks.lint-links]
+description = "Lint markdown links"
 run = "lychee --include-fragments ."
 
-[tasks.lint-bom]
-run = "scripts/lint-bom.sh"
-
 [tasks.lint-rest]
 description = "All lints not covered by super linter"
 depends = ["lint-links", "lint-bom"]
@@ -61,41 +56,26 @@ description = "Run OATs acceptance tests"
 depends = "build"
 run = "oats -timeout 5m examples/"
 
-[tasks.set-version]
-run = './scripts/set-version.sh {{arg(name="version")}}'
-
 [tasks.javadoc]
+description = "Generate Javadoc"
 run = [
   "./mvnw -B clean compile javadoc:javadoc javadoc:aggregate -P 'javadoc,!default'",
   "rm -rf ./docs/static/api",
   "mv ./target/reports/apidocs ./docs/static/api && echo && echo 'ls ./docs/static/api' && ls ./docs/static/api"
 ]
 
-[tasks.set-gh-pages-version]
-run = "./scripts/set-release-version-github-pages.sh"
-
 [tasks.gh-pages-dev]
 description = "Build GitHub pages for dev"
 run = "hugo server -D"
 dir = "docs"
 
 [tasks.build-gh-pages]
 description = "Build GitHub pages"
-depends = ["javadoc", "set-gh-pages-version"]
+depends = ["javadoc", "set-release-version-github-pages"]
 # For maximum backward compatibility with Hugo modules
 env = { HUGO_ENVIRONMENT = "production", HUGO_ENV = "production" }
 dir = "docs"
 run = [
   "hugo --gc --minify --baseURL ${BASE_URL}/",
   "echo 'ls ./public/api' && ls ./public/api"
 ]
-
-[tasks.build-release]
-description = "Build release"
-run = "./scripts/build-release.sh"
-env.TAG = "1.5.0-SNAPSHOT"
-
-[settings]
-# to get lock file support and for go backend
-experimental = true
-
diff --git a/scripts/set-version.sh b/scripts/set-version.sh

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# shellcheck configuration for mise tasks`
	`2`	`+# SC2154: usage_* variables are set by mise framework`
	`3`	`+disable=SC2154`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`#!/usr/bin/env bash`
	`2`	`+#MISE description="Make sure the BOM has all necessary modules"`
`2`	`3`
`3`	`4`	`set -euo pipefail`
`4`	`5`