fix gh pages, add super linter (#1338)

Signed-off-by: Gregor Zeitlinger <[email protected]>

Author: zeitlinger

.editorconfig

@@ -4,5 +4,15 @@ root = true
 max_line_length = 100
 indent_size = 2
 
+[{version-rules.xml,maven-wrapper.properties,checkstyle.xml,docker-compose.yaml,docker-compose.yml,Dockerfile,example_target_info.json,mise.toml,mise.lock,mvnm,mvnw.cmd,generate-protobuf.sh,super-linter.env,.gitleaksignore}]
+max_line_length = 200
+
+[{grafana-dashboard-*.json,.editorconfig}]
+max_line_length = 300
+
 [pom.xml]
+max_line_length = 110
+
+[*.py]
+# checked by black
 indent_size = 4

.github/dependabot.yml

@@ -1,12 +1,15 @@
+---
 version: 2
 updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: weekly
   - package-ecosystem: maven
-    # excluding simpleclient_archive from the update is not possible, only includes are supported
-    # when we use includes, we run into https://github.com/dependabot/dependabot-core/issues/10415 -
+    # excluding simpleclient_archive from the update is not possible,
+    # only includes are supported
+    # when we use includes,
+    # we run into https://github.com/dependabot/dependabot-core/issues/10415
     # even if we limit to 1 PR at a time
     # therefore we just rename pom.xml in simpleclient_archive for now
     # if this becomes a problem, we can move to renovate

.github/super-linter.env

@@ -0,0 +1,34 @@
+FILTER_REGEX_EXCLUDE=mvnw|src/main/generated/.*|docs/themes/.*|keystore.pkcs12|.*.java|prometheus-metrics-exporter-opentelemetry-shaded/pom.xml
+IGNORE_GITIGNORED_FILES=true
+JAVA_FILE_NAME=google_checks.xml
+# disable kubernetes linter - complains about resource limits, etc
+VALIDATE_CHECKOV=false
+VALIDATE_CSS=false
+VALIDATE_CSS_PRETTIER=false
+VALIDATE_DOCKERFILE_HADOLINT=false
+VALIDATE_GIT_COMMITLINT=false
+# done by maven
+VALIDATE_GOOGLE_JAVA_FORMAT=false
+# times out
+VALIDATE_GO_MODULES=false
+VALIDATE_HTML=false
+# done by checkstyle
+VALIDATE_JAVA=false
+# contradicting with prettier
+VALIDATE_JAVASCRIPT_STANDARD=false
+# we have many duplicate code in our codebase for demo purposes
+VALIDATE_JSCPD=false
+VALIDATE_PYTHON_PYLINT=false
+
+FIX_ENV=true
+FIX_GO=true
+FIX_JAVASCRIPT_PRETTIER=true
+FIX_JSON=true
+FIX_JSONC=true
+FIX_JSONC_PRETTIER=true
+FIX_JSON_PRETTIER=true
+FIX_MARKDOWN=true
+FIX_MARKDOWN_PRETTIER=true
+FIX_PYTHON_BLACK=true
+FIX_SHELL_SHFMT=true
+FIX_YAML_PRETTIER=true

.github/workflows/acceptance-tests.yml

@@ -1,10 +1,11 @@
+---
 name: OpenTelemetry Acceptance Tests
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 permissions: {}
 

.github/workflows/build.yml

@@ -1,10 +1,11 @@
+---
 name: Build
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 permissions: {}
 
@@ -25,4 +26,3 @@ jobs:
             ${{ runner.os }}-maven-
       - name: Run the Maven verify phase
         run: mise run ci
-

.github/workflows/github-pages.yaml

@@ -13,8 +13,10 @@ on:
 
 permissions: {}
 
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+# Allow only one concurrent deployment, skipping runs queued between
+# the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow
+# these production deployments to complete.
 concurrency:
   group: "pages"
   cancel-in-progress: false
@@ -32,22 +34,18 @@ jobs:
       - uses: actions/checkout@v4
         with:
           persist-credentials: false
-          fetch-tags: 'true'
+          fetch-tags: "true"
           fetch-depth: 0
       - uses: jdx/mise-action@7a111ead46986ccad89a74ad013ba2a7c08c9e67 # v2.1.1
         with:
-          cache: 'false'
+          cache: "false"
       - name: Prepare GitHub Pages
         run: mise run prepare-gh-pages
-        with:
-          permissions: block
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
       - name: Build GitHub Pages
         run: mise run build-gh-pages
-        with:
-          permissions: block
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.github/workflows/lint.yml renamed to .github/workflows/lint-rest.yml

@@ -7,7 +7,6 @@ permissions: {}
 
 jobs:
   acceptance-tests:
-    permissions: {}
     runs-on: ubuntu-24.04
     steps:
       - name: Check out
@@ -16,5 +15,4 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - uses: jdx/mise-action@7a111ead46986ccad89a74ad013ba2a7c08c9e67 # v2.1.1
       - name: Lint
-        run: mise run lint-all
-
+        run: mise run lint-rest

.github/workflows/native-tests.yml

@@ -1,10 +1,11 @@
+---
 name: GraalVM Native Tests
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 permissions: {}
 

.github/workflows/release.yml

@@ -1,3 +1,4 @@
+---
 name: Deploy to Maven Central
 
 on:
@@ -14,10 +15,10 @@ jobs:
     steps:
       - name: Debug gpg key - remove after debugging
         env:
-            GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }}
+          GPG_SIGNING_KEY: ${{ secrets.GPG_SIGNING_KEY }}
         run: |
-          echo "$GPG_SIGNING_KEY" | wc -c
-          echo "$GPG_SIGNING_KEY" | gpg --batch --import-options import-show --import
+          echo "${#GPG_SIGNING_KEY}"
+          echo "${GPG_SIGNING_KEY}" | gpg --batch --import-options import-show --import
       - name: Checkout Plugin Repository
         uses: actions/checkout@v4
         with:
@@ -37,8 +38,8 @@ jobs:
       - name: Set up Apache Maven Central
         uses: actions/setup-java@v4
         with:
-          distribution: 'temurin'
-          java-version: '17'
+          distribution: "temurin"
+          java-version: "17"
           server-id: ossrh
           server-username: MAVEN_USERNAME
           server-password: MAVEN_CENTRAL_TOKEN

.github/workflows/super-linter.yml

@@ -0,0 +1,31 @@
+---
+name: Lint
+
+on:
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-24.04
+
+    permissions:
+      contents: read
+      packages: read
+      # To report GitHub Actions status checks
+      statuses: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Load super-linter configuration
+        run: grep -v '^#' .github/super-linter.env | grep -v 'FIX_' >> "$GITHUB_ENV"
+
+      - name: Super-linter
+        uses: super-linter/super-linter@4e8a7c2bf106c4c766c816b35ec612638dc9b6b2 # v7.3.0
+        env:
+          # To report GitHub Actions status checks
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -18,3 +18,5 @@ dependency-reduced-pom.xml
 **/.classpath
 **.project
 **/.settings/
+docs/public
+.lycheecache

.gitleaksignore

@@ -0,0 +1,2 @@
+/tmp/lint/integration-tests/it-pushgateway/src/test/resources/pushgateway-ssl.yaml:private-key:36
+/github/workspace/integration-tests/it-pushgateway/src/test/resources/pushgateway-ssl.yaml:private-key:36

.yaml-lint.yml

@@ -0,0 +1,5 @@
+extends: relaxed
+
+rules:
+  line-length:
+    max: 120

CODE_OF_CONDUCT.md

@@ -1,3 +1,4 @@
 # Prometheus Community Code of Conduct
 
-Prometheus follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
+Prometheus follows the
+[CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).

CONTRIBUTING.md

@@ -2,26 +2,28 @@
 
 Prometheus uses GitHub to manage reviews of pull requests.
 
-* If you have a trivial fix or improvement, go ahead and create a pull request,
+- If you have a trivial fix or improvement, go ahead and create a pull request,
   addressing (with `@...`) the maintainer of this repository (see
   [MAINTAINERS.md](MAINTAINERS.md)) in the description of the pull request.
 
-* If you plan to do something more involved, first discuss your ideas
+- If you plan to do something more involved, first discuss your ideas
   on our [mailing list](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers).
   This will avoid unnecessary work and surely give you and us a good deal
   of inspiration.
 
 ## Formatting
 
-This repository uses [Google Java Format](https://github.com/google/google-java-format) to format the code.
+This repository uses [Google Java Format](https://github.com/google/google-java-format) to format
+the code.
 
 Run `./mvnw spotless:apply` to format the code (only changed files) before committing.
 
 ## Running Tests
 
 If you're getting errors when running tests:
 
-- Make sure that the IDE uses only the "Maven Shade" dependency of "prometheus-metrics-exposition-formats" and the "prometheus-metrics-tracer*" dependencies.
+- Make sure that the IDE uses only the "Maven Shade" dependency of "
+  prometheus-metrics-exposition-formats" and the "prometheus-metrics-tracer\*" dependencies.
 
 ### Avoid failures while running tests
 
@@ -30,7 +32,8 @@ If you're getting errors when running tests:
 - Use `-Dcheckstyle.skip=true` to skip the checkstyle check during development.
 - Use `-Dwarnings=-nowarn` to skip the warnings during development.
 
-Combine all with `./mvnw test -DskipTests=true -Dspotless.check.skip=true -Dcoverage.skip=true -Dcheckstyle.skip=true -Dwarnings=-nowarn`.
+Combine all with
+`./mvnw test -DskipTests=true -Dspotless.check.skip=true -Dcoverage.skip=true -Dcheckstyle.skip=true -Dwarnings=-nowarn`. # editorconfig-checker-disable-line
 
 ## Updating the Protobuf Java Classes
 

MAINTAINERS.md

@@ -1,4 +1,6 @@
-* Fabian Stäber <[email protected]> @fstab
-* Doug Hoard <[email protected]> @dhoard
-* Tom Wilkie <[email protected]> @tomwilkie
-* Gregor Zeitlinger <[email protected]> @zeitlinger
+# Maintainers
+
+- Fabian Stäber <[email protected]> @fstab
+- Doug Hoard <[email protected]> @dhoard
+- Tom Wilkie <[email protected]> @tomwilkie
+- Gregor Zeitlinger <[email protected]> @zeitlinger

README.md

@@ -1,21 +1,25 @@
 # Prometheus Java Metrics Library
 
-[![Build](https://github.com/prometheus/client_java/actions/workflows/build.yml/badge.svg)](https://github.com/prometheus/client_java/actions/workflows/build.yml) <a href="#"><img src="https://img.shields.io/badge/JDK%20compatibility-8+-blue.svg" alt="java 8+"></a> <a href="#"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="Apache 2.0"></a>
+[![Build](https://github.com/prometheus/client_java/actions/workflows/build.yml/badge.svg)](https://github.com/prometheus/client_java/actions/workflows/build.yml) <a href="#"><img src="https://img.shields.io/badge/JDK%20compatibility-8+-blue.svg" alt="java 8+"></a> <a href="#"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="Apache 2.0"></a> # editorconfig-checker-disable-line
 
-# Documentation
+## Documentation
 
 [https://prometheus.github.io/client_java](https://prometheus.github.io/client_java)
 
-# Contributing and community
+## Contributing and community
 
-See [CONTRIBUTING.md](CONTRIBUTING.md) and the [community section](http://prometheus.io/community/) of the Prometheus homepage.
+See [CONTRIBUTING.md](CONTRIBUTING.md) and the [community section](http://prometheus.io/community/)
+of the Prometheus homepage.
 
-The Prometheus Java community is present on the [CNCF Slack](https://cloud-native.slack.com) on `#prometheus-java`, and we have a fortnightly community call in the [Prometheus public calendar](https://prometheus.io/community/).
+The Prometheus Java community is present on the [CNCF Slack](https://cloud-native.slack.com) on
+`#prometheus-java`, and we have a fortnightly community call in
+the [Prometheus public calendar](https://prometheus.io/community/).
 
-# Previous Releases
+## Previous Releases
 
-The source code for 0.16.0 and older is on the [simpleclient](https://github.com/prometheus/client_java/tree/simpleclient) branch.
+The source code for 0.16.0 and older is on
+the [simpleclient](https://github.com/prometheus/client_java/tree/simpleclient) branch.
 
-# License
+## License
 
 Apache License 2.0, see [LICENSE](LICENSE).

RELEASING.md

@@ -1,6 +1,7 @@
-## Create a Release
+# Create a Release
 
-1. Go to https://github.com/prometheus/client_java/releases/new
+1. Go to <https://github.com/prometheus/client_java/releases/new>
 2. Click on "Choose a tag", enter the tag name (e.g. `v0.1.0`), and click "Create a new tag".
-3. Click on "Generate release notes" to auto-generate the release notes based on the commits since the last release.
+3. Click on "Generate release notes" to auto-generate the release notes based on the commits since
+   the last release.
 4. Click on "Publish release".

benchmarks/README.md

@@ -1,32 +1,37 @@
-Benchmarks
-----------
+# Benchmarks
 
 ## How to Run
 
-```
+```shell
 java -jar ./benchmarks/target/benchmarks.jar
 ```
 
 Run only one specific benchmark:
 
-```
+```shell
 java -jar ./benchmarks/target/benchmarks.jar CounterBenchmark
 ```
 
 ## Results
 
 See Javadoc of the benchmark classes:
 
-* [CounterBenchmark](https://github.com/prometheus/client_java/blob/1.0.x/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/CounterBenchmark.java)
-* [HistogramBenchmark](https://github.com/prometheus/client_java/blob/1.0.x/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/HistogramBenchmark.java)
+- [CounterBenchmark](https://github.com/prometheus/client_java/blob/1.0.x/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/CounterBenchmark.java) <!-- editorconfig-checker-disable-line -->
+- [HistogramBenchmark](https://github.com/prometheus/client_java/blob/1.0.x/benchmarks/src/main/java/io/prometheus/metrics/benchmarks/HistogramBenchmark.java) <!-- editorconfig-checker-disable-line -->
 
 ## What Prometheus Java client optimizes for
 
 concurrent updates of metrics in multi-threaded applications.
-If your application is single-threaded and uses only one processor core, your application isn't performance critical anyway.
-If your application is designed to use all available processor cores for maximum performance, then you want a metric library that doesn't slow your application down.
-Prometheus client Java metrics support concurrent updates and scrapes. This shows in benchmarks with multiple threads recording data in shared metrics.
+If your application is single-threaded and uses only one processor core, your application isn't
+performance critical anyway.
+If your application is designed to use all available processor cores for maximum performance, then
+you want a metric library that doesn't slow your
+application down.
+Prometheus client Java metrics support concurrent updates and scrapes. This shows in benchmarks with
+multiple threads recording data in shared
+metrics.
 
 ## Archive
 
-The `src/main/archive/` directory contains the old benchmarks from 0.16.0 and earlier. It will be removed as soon as all benchmarks are ported to the 1.0.0 release.
+The `src/main/archive/` directory contains the old benchmarks from 0.16.0 and earlier. It will be
+removed as soon as all benchmarks are ported to the 1.0.0 release.