Release automation

.github/workflows/build.yml

@@ -28,4 +28,4 @@ jobs:
           REQUIRE_PROTO_UP_TO_DATE: true
         run: |
           ./mvnw clean install
-          ./mvnw javadoc:javadoc
+          ./mvnw javadoc:javadoc -P release # just to check if javadoc is generated

.github/workflows/github-pages.yaml

@@ -44,17 +44,10 @@ jobs:
         run: |
           wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
           && sudo dpkg -i ${{ runner.temp }}/hugo.deb
-      #- name: Install Dart Sass
-      #  run: sudo snap install dart-sass
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
-          fetch-depth: 0
       - name: Build client_java
-        run: ./mvnw -B clean install -DskipTests
+        run: ./mvnw -B clean install -DskipTests -P release
       - name: Make Javadoc
-        run: ./mvnw -B clean compile javadoc:javadoc javadoc:aggregate
+        run: ./mvnw -B clean compile javadoc:javadoc javadoc:aggregate -P release
       - name: Move the Javadoc to docs/static/api/
         run: mv ./target/reports/apidocs ./docs/static/api && echo && echo 'ls ./docs/static/api' && ls ./docs/static/api
       - name: Setup Pages

.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Deploy to Maven Central
+
+#on:
+#  push:
+#    tags:
+#      - v*
+on:
+  push:
+    branches: [ "main" ]
+#  pull_request:
+#    branches: [ "main" ]
+
+jobs:
+  deploy:
+    if: ${{ github.repository == 'prometheus/client_java' }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Plugin Repository
+        uses: actions/checkout@v4
+
+      - name: Set Up JDK
+        uses: actions/setup-java@v4
+        with:
+          java-version: 17
+          distribution: temurin
+          cache: 'maven'
+
+      - name: Build with Maven
+        run: mvn -B package -P release -Dmaven.test.skip=true
+
+      - name: Set up Apache Maven Central
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          server-id: ossrh
+          server-username: MAVEN_USERNAME
+          server-password: MAVEN_CENTRAL_TOKEN
+          gpg-private-key: ${{ secrets.GPG_SIGNING_KEY }}
+          gpg-passphrase: MAVEN_GPG_PASSPHRASE
+
+      - name: Publish to Apache Maven Central
+        run: mvn deploy -P release
+        env:
+          MAVEN_USERNAME: ${{ secrets.SONATYPE_MAVEN_REPOSITORY_USERNAME }}
+          MAVEN_CENTRAL_TOKEN: ${{ secrets.SONATYPE_MAVEN_REPOSITORY_PASSWORD }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_SIGNING_PASSPHRASE }}

CONTRIBUTING.md

@@ -22,3 +22,7 @@ Run `./mvnw spotless:apply` to format the code (only changed files) before commi
 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.
+
+## Updating the Protobuf Java Classes
+
+Use `PROTO_GENERATION=true mvn clean install` to generate protobuf classes.

RELEASING.md

@@ -0,0 +1,25 @@
+## Update Version
+
+In a new PR, update the version in `pom.xml` using 
+
+```shell
+mvn versions:set -DnewVersion=<VERSION>
+```
+
+Commit the changes and open a PR.
+
+## Publish Release via Github Workflow
+
+On main branch, create a tag for the new version to trigger the release workflow.
+
+```sh
+git tag -a v<VERSION> -m "Release v<VERSION>"
+git push origin v<VERSION>
+```
+
+## Create a Release 
+
+1. Go to https://github.com/prometheus/client_java/releases
+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.
+4. Click on "Publish release".

benchmarks/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>client_java</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>benchmarks</artifactId>
@@ -20,7 +20,6 @@
         <jmh.version>1.37</jmh.version>
         <simpleclient.version>0.16.0</simpleclient.version>
         <codahale.version>3.0.2</codahale.version>
-        <maven.javadoc.skip>true</maven.javadoc.skip>
     </properties>
 
     <dependencies>

examples/example-exemplars-tail-sampling/example-greeting-service/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>example-exemplars-tail-sampling</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>example-greeting-service</artifactId>

examples/example-exemplars-tail-sampling/example-hello-world-app/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>example-exemplars-tail-sampling</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>example-hello-world-app</artifactId>

examples/example-exemplars-tail-sampling/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>examples</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>example-exemplars-tail-sampling</artifactId>

examples/example-exporter-httpserver/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>examples</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>example-exporter-httpserver</artifactId>

examples/example-exporter-multi-target/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>examples</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>example-exporter-multi-target</artifactId>

examples/example-exporter-opentelemetry/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>examples</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>example-exporter-opentelemetry</artifactId>

examples/example-exporter-servlet-tomcat/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>examples</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>example-exporter-servlet-tomcat</artifactId>

examples/example-native-histogram/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>examples</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>example-native-histogram</artifactId>

examples/example-prometheus-properties/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>examples</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>example-prometheus-properties</artifactId>

examples/example-simpleclient-bridge/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>examples</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>example-simpleclient-bridge</artifactId>

examples/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>client_java</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>examples</artifactId>
@@ -16,10 +16,6 @@
         Example projects for the Prometheus Metrics Library.
     </description>
 
-    <properties>
-        <maven.javadoc.skip>true</maven.javadoc.skip>
-    </properties>
-
     <modules>
         <module>example-exemplars-tail-sampling</module>
         <module>example-exporter-servlet-tomcat</module>

integration-tests/it-common/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>integration-tests</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>it-common</artifactId>

integration-tests/it-exporter/it-exporter-httpserver-sample/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>it-exporter</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>it-exporter-httpserver-sample</artifactId>

integration-tests/it-exporter/it-exporter-servlet-jetty-sample/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>it-exporter</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>it-exporter-servlet-jetty-sample</artifactId>

integration-tests/it-exporter/it-exporter-servlet-tomcat-sample/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>it-exporter</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>it-exporter-servlet-tomcat-sample</artifactId>

integration-tests/it-exporter/it-exporter-test/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>it-exporter</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>it-exporter-test</artifactId>
@@ -16,10 +16,6 @@
         Integration Tests for Exporters
     </description>
 
-    <properties>
-        <maven.javadoc.skip>true</maven.javadoc.skip>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>io.prometheus</groupId>

integration-tests/it-exporter/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>integration-tests</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>it-exporter</artifactId>

integration-tests/it-pushgateway/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>io.prometheus</groupId>
         <artifactId>integration-tests</artifactId>
-        <version>1.4.0-SNAPSHOT</version>
+        <version>0.0.1-releasetest1</version>
     </parent>
 
     <artifactId>it-pushgateway</artifactId>
@@ -16,10 +16,6 @@
         Integration tests for the Pushgateway Exporter
     </description>
 
-    <properties>
-        <maven.javadoc.skip>true</maven.javadoc.skip>
-    </properties>
-
     <dependencies>
         <dependency>
             <groupId>io.prometheus</groupId>