Skip to content

Commit 013455d

Browse files
committed
fix: add lint tool configs and fix pre-existing violations
- .markdownlint.json: disable MD013/MD031/MD033/MD036 (line length, fences, inline HTML, emphasis-as-heading — all pre-existing in docs) - .codespellrc: ignore nd/atmost/re-use/errorprone (false positives in Java identifiers and comments) - .editorconfig: extend workflow exemption to all .github/workflows/*.yml at 300 chars; add CODE_OF_CONDUCT.md to high-limit group - .editorconfig-checker.json: explicitly exclude *.java (handled by google-java-format via defer_to_formatters, belt-and-suspenders) - flint.toml: add simpleclient-archive/ to exclude_paths - SpanContext.java: fix Examplar → Exemplar typo - renovate-tracked-deps.json: regenerated (pretty-print normalisation) - java-version-matrix-tests.yml: prettier quote normalisation - Metrics.java: google-java-format string split normalisation Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>
1 parent 98eac21 commit 013455d

9 files changed

Lines changed: 122 additions & 45 deletions

File tree

.codespellrc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[codespell]
2-
# Ignore words that are valid technical terms:
3-
# - vertx: Vert.x reactive framework
4-
# - errorprone: Error Prone static analysis tool
5-
ignore-words-list = vertx,errorprone
2+
# nd: legitimate variable name in quantile algorithms
3+
# atmost: AssertJ atMost() matcher
4+
# re-use: hyphenated form used in comments
5+
# errorprone: Google ErrorProne tool name
6+
ignore-words-list = nd,atmost,re-use,errorprone

.editorconfig

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ indent_size = 2
77
[{version-rules.xml,maven-wrapper.properties,checkstyle.xml,docker-compose.yaml,docker-compose.yml,Dockerfile,example_target_info.json,mise.toml,mvnm,mvnw.cmd,generate-protobuf.sh,.gitleaksignore,prometheus.properties}]
88
max_line_length = 200
99

10-
[{grafana-dashboard-*.json,.editorconfig,super-linter.env,lychee.toml,renovate.json5}]
10+
[{grafana-dashboard-*.json,.editorconfig,super-linter.env,lychee.toml,renovate.json5,CODE_OF_CONDUCT.md}]
1111
max_line_length = 300
1212

1313
[pom.xml]
@@ -18,5 +18,5 @@ max_line_length = 120
1818
indent_size = 4
1919
max_line_length = 120
2020

21-
[{.mise/tasks/build-release.sh,.github/workflows/multi-version-test.yml}]
22-
max_line_length = 200
21+
[{.mise/tasks/build-release.sh,.github/workflows/*.yml}]
22+
max_line_length = 300
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"Exclude": [".*\\.java$"]
3+
}

.github/config/flint.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ exclude = "src/main/generated"
33
exclude_paths = [
44
"docs/themes/",
55
"mvnw",
6+
"simpleclient-archive/",
67
]
78

89
[checks.renovate-deps]

.github/renovate-tracked-deps.json

Lines changed: 95 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,68 @@
11
{
22
".github/renovate.json5": {
3-
"renovate-config-presets": ["grafana/flint"]
3+
"renovate-config-presets": [
4+
"grafana/flint"
5+
]
46
},
57
".github/workflows/acceptance-tests.yml": {
6-
"regex": ["mise"]
8+
"regex": [
9+
"mise"
10+
]
711
},
812
".github/workflows/build.yml": {
9-
"regex": ["mise"]
13+
"regex": [
14+
"mise"
15+
]
1016
},
1117
".github/workflows/generate-protobuf.yml": {
12-
"regex": ["mise"]
18+
"regex": [
19+
"mise"
20+
]
1321
},
1422
".github/workflows/github-pages.yaml": {
15-
"regex": ["mise"]
23+
"regex": [
24+
"mise"
25+
]
1626
},
1727
".github/workflows/java-version-matrix-tests.yml": {
18-
"regex": ["mise"]
28+
"regex": [
29+
"mise"
30+
]
1931
},
2032
".github/workflows/lint.yml": {
21-
"regex": ["mise"]
33+
"regex": [
34+
"mise"
35+
]
2236
},
2337
".github/workflows/native-tests.yml": {
24-
"regex": ["mise"]
38+
"regex": [
39+
"mise"
40+
]
2541
},
2642
".github/workflows/nightly-benchmarks.yml": {
27-
"regex": ["mise"]
43+
"regex": [
44+
"mise"
45+
]
2846
},
2947
".github/workflows/release.yml": {
30-
"regex": ["mise"]
48+
"regex": [
49+
"mise"
50+
]
3151
},
3252
".github/workflows/test-release-build.yml": {
33-
"regex": ["mise"]
53+
"regex": [
54+
"mise"
55+
]
3456
},
3557
".mise/envs/native/mise.toml": {
36-
"mise": ["java"]
58+
"mise": [
59+
"java"
60+
]
3761
},
3862
".mvn/wrapper/maven-wrapper.properties": {
39-
"maven-wrapper": ["maven"]
63+
"maven-wrapper": [
64+
"maven"
65+
]
4066
},
4167
"benchmarks/pom.xml": {
4268
"maven": [
@@ -94,13 +120,21 @@
94120
]
95121
},
96122
"integration-tests/it-exporter/it-exporter-test/pom.xml": {
97-
"maven": ["io.prometheus:it-common", "io.prometheus:it-exporter"]
123+
"maven": [
124+
"io.prometheus:it-common",
125+
"io.prometheus:it-exporter"
126+
]
98127
},
99128
"integration-tests/it-exporter/it-no-protobuf-test/pom.xml": {
100-
"maven": ["io.prometheus:it-common", "io.prometheus:it-exporter"]
129+
"maven": [
130+
"io.prometheus:it-common",
131+
"io.prometheus:it-exporter"
132+
]
101133
},
102134
"integration-tests/it-exporter/pom.xml": {
103-
"maven": ["io.prometheus:integration-tests"]
135+
"maven": [
136+
"io.prometheus:integration-tests"
137+
]
104138
},
105139
"integration-tests/it-pushgateway/pom.xml": {
106140
"maven": [
@@ -130,21 +164,34 @@
130164
},
131165
"mise.toml": {
132166
"mise": [
167+
"actionlint",
168+
"cargo:https://github.com/grafana/flint",
169+
"editorconfig-checker",
133170
"go:github.com/gohugoio/hugo",
134171
"go:github.com/grafana/oats",
135172
"java",
136173
"lychee",
137174
"node",
175+
"npm:markdownlint-cli2",
176+
"npm:prettier",
138177
"npm:renovate",
139-
"protoc"
140-
],
141-
"regex": ["ghcr.io/super-linter/super-linter", "grafana/flint"]
178+
"pipx:codespell",
179+
"pipx:ruff",
180+
"protoc",
181+
"shellcheck",
182+
"shfmt",
183+
"ubi:google/google-java-format"
184+
]
142185
},
143186
"mvnw": {
144-
"maven-wrapper": ["maven-wrapper"]
187+
"maven-wrapper": [
188+
"maven-wrapper"
189+
]
145190
},
146191
"mvnw.cmd": {
147-
"maven-wrapper": ["maven-wrapper"]
192+
"maven-wrapper": [
193+
"maven-wrapper"
194+
]
148195
},
149196
"pom.xml": {
150197
"maven": [
@@ -218,7 +265,9 @@
218265
]
219266
},
220267
"prometheus-metrics-config/pom.xml": {
221-
"maven": ["io.prometheus:client_java"]
268+
"maven": [
269+
"io.prometheus:client_java"
270+
]
222271
},
223272
"prometheus-metrics-core/pom.xml": {
224273
"maven": [
@@ -240,7 +289,10 @@
240289
]
241290
},
242291
"prometheus-metrics-exporter-httpserver/pom.xml": {
243-
"maven": ["io.prometheus:client_java", "io.prometheus:prometheus-metrics-exporter-common"]
292+
"maven": [
293+
"io.prometheus:client_java",
294+
"io.prometheus:prometheus-metrics-exporter-common"
295+
]
244296
},
245297
"prometheus-metrics-exporter-opentelemetry-otel-agent-resources/pom.xml": {
246298
"maven": [
@@ -349,10 +401,15 @@
349401
]
350402
},
351403
"prometheus-metrics-model/pom.xml": {
352-
"maven": ["io.prometheus:client_java", "io.prometheus:prometheus-metrics-config"]
404+
"maven": [
405+
"io.prometheus:client_java",
406+
"io.prometheus:prometheus-metrics-config"
407+
]
353408
},
354409
"prometheus-metrics-otel-support/pom.xml": {
355-
"maven": ["io.prometheus:client_java"]
410+
"maven": [
411+
"io.prometheus:client_java"
412+
]
356413
},
357414
"prometheus-metrics-parent/pom.xml": {
358415
"maven": [
@@ -373,10 +430,14 @@
373430
]
374431
},
375432
"prometheus-metrics-tracer/pom.xml": {
376-
"maven": ["io.prometheus:client_java"]
433+
"maven": [
434+
"io.prometheus:client_java"
435+
]
377436
},
378437
"prometheus-metrics-tracer/prometheus-metrics-tracer-common/pom.xml": {
379-
"maven": ["io.prometheus:prometheus-metrics-tracer"]
438+
"maven": [
439+
"io.prometheus:prometheus-metrics-tracer"
440+
]
380441
},
381442
"prometheus-metrics-tracer/prometheus-metrics-tracer-initializer/pom.xml": {
382443
"maven": [
@@ -399,7 +460,9 @@
399460
]
400461
},
401462
"simpleclient-archive/integration_tests/it_common/pom.xml": {
402-
"maven": ["io.prometheus:integration_tests"]
463+
"maven": [
464+
"io.prometheus:integration_tests"
465+
]
403466
},
404467
"simpleclient-archive/integration_tests/it_exemplars_otel_agent/pom.xml": {
405468
"maven": [
@@ -474,7 +537,10 @@
474537
]
475538
},
476539
"simpleclient-archive/simpleclient_graphite_bridge/pom.xml": {
477-
"maven": ["io.prometheus:client_java", "io.prometheus:simpleclient"]
540+
"maven": [
541+
"io.prometheus:client_java",
542+
"io.prometheus:simpleclient"
543+
]
478544
},
479545
"simpleclient-archive/simpleclient_hibernate/pom.xml": {
480546
"maven": [

.github/workflows/java-version-matrix-tests.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ name: Integration Tests - Java Version Compatibility Matrix
44
on:
55
pull_request:
66
paths:
7-
- 'integration-tests/**'
8-
- 'prometheus-metrics-core/**'
9-
- 'prometheus-metrics-exporter-*/**'
10-
- 'prometheus-metrics-exposition-*/**'
11-
- '.github/workflows/java-version-matrix-tests.yml'
7+
- "integration-tests/**"
8+
- "prometheus-metrics-core/**"
9+
- "prometheus-metrics-exporter-*/**"
10+
- "prometheus-metrics-exposition-*/**"
11+
- ".github/workflows/java-version-matrix-tests.yml"
1212
push:
1313
branches:
1414
- main

.markdownlint.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"MD013": false,
3+
"MD031": false,
4+
"MD033": false,
5+
"MD036": false
6+
}

prometheus-metrics-exposition-formats/src/main/generated/io/prometheus/metrics/expositionformats/generated/com_google_protobuf_4_34_0/Metrics.java

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

prometheus-metrics-tracer/prometheus-metrics-tracer-common/src/main/java/io/prometheus/metrics/tracer/common/SpanContext.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public interface SpanContext {
2525
* @return the state of the current Span. If this value is false a component before in the chain
2626
* take the decision to not record it. Subsequent calling service have to respect this value
2727
* in order not to have partial TraceID with only some Span in it. This value is important to
28-
* be sure to choose a recorded Trace in Examplar sampling process
28+
* be sure to choose a recorded Trace in Exemplar sampling process
2929
*/
3030
boolean isCurrentSpanSampled();
3131

0 commit comments

Comments
 (0)