Use CI-friendly revision to set the project version (#12640)

apache · Sep 24, 2024 · a5d8777 · a5d8777
1 parent 7d1b65c
commit a5d8777
Show file tree

Hide file tree

Showing 94 changed files with 162 additions and 109 deletions.
diff --git a/.github/workflows/skywalking.yaml b/.github/workflows/skywalking.yaml
@@ -178,9 +178,10 @@ jobs:
         run: |
           ./mvnw clean install javadoc:javadoc -B -q -Pall \
             -Dmaven.test.skip \
-            -Dcheckstyle.skip
+            -Dcheckstyle.skip \
+            -Dgpg.skip
       - name: Verify builds are reproducible
-        run: ./mvnw -Dmaven.test.skip clean verify artifact:compare -Pall
+        run: ./mvnw -Dmaven.test.skip clean verify artifact:compare -Pall -Dgpg.skip
       - uses: actions/upload-artifact@v4
         name: Upload distribution tar
         with:

diff --git a/apm-dist/pom.xml b/apm-dist/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>apm</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/apm-protocol/apm-network/pom.xml b/apm-protocol/apm-network/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-protocol</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/apm-protocol/pom.xml b/apm-protocol/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>apm</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/apm-webapp/pom.xml b/apm-webapp/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>apm</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
@@ -9,6 +9,7 @@
 * Bump up skywalking-infra-e2e to work around GHA removing `docker-compose` v1.
 * Bump up CodeQL GitHub Actions.
 * Fix wrong phase of delombok plugin to reduce build warnings.
+* Use ci-friendly revision to set the project version.
 
 #### OAP Server
 

diff --git a/docs/en/guides/How-to-release.md b/docs/en/guides/How-to-release.md
@@ -43,25 +43,56 @@ This step is only for testing purpose. If your env is correctly set, you don't n
 ```
 
 ## Prepare for the release
+
+- Make sure you local repo is clean, up-to-date, and no uncommitted changes.
+
+```bash
+git checkout master
+git pull
+git checkout .
+git clean -df
+git submodule update
+```
+
+- Set the version number that you are about to release.
+
+```bash
+export RELEASE_VERSION=x.y.z # (example: RELEASE_VERSION=10.1.0)
 ```
-./mvnw release:clean
-./mvnw release:prepare -DautoVersionSubmodules=true -Darguments='-Dmaven.test.skip' -Pall
+
+- Update the property `revision` in `pom.xml` file, and commit it.
+
+```bash
+./mvnw versions:set-property -DgenerateBackupPoms=false -Dproperty=revision -DnewVersion=${RELEASE_VERSION}
+git add pom.xml
+git commit -m "Prepare for release ${RELEASE_VERSION}"
 ```
 
-- Set version number as x.y.z, and tag as **v**x.y.z (The version tag must start with **v**. You will find out why this is necessary in the next step.)
+- Tag the commit and push it to the upstream.
 
-_You could do a GPG signature before preparing for the release. If you need to input the password to sign, and the maven doesn't provide you with the opportunity to do so, this may lead to failure of the release. To resolve this, you may run `gpg --sign xxx` in any file. This will allow it to remember the password for long enough to prepare for the release._ 
+```bash
+git tag v${RELEASE_VERSION}
+git push origin v${RELEASE_VERSION}
+```
 
 ## Stage the release 
+
+```bash
+./mvnw install deploy -DskipTests
 ```
-./mvnw release:perform -Darguments='-Dmaven.test.skip' -Pall
+
+This command will build, sign, and deploy the release to the Apache staging repository.
+You should be prompted for your GPG passphrase during the deployment process.
+If no prompt is present, you can set the passphrase in the environment variable `MAVEN_GPG_PASSPHRASE`:
+
+```bash
+MAVEN_GPG_PASSPHRASE=<your-gpg-passphrase> ./mvnw install deploy -DskipTests
 ```
 
 - The release will be automatically inserted into a temporary staging repository.
 
 ## Build and sign the source code package
-```shell
-export RELEASE_VERSION=x.y.z (example: RELEASE_VERSION=5.0.0-alpha)
+```bash
 cd tools/releasing
 bash create_source_release.sh
 ```

diff --git a/oap-server-bom/pom.xml b/oap-server-bom/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>apm</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <packaging>pom</packaging>
     <modelVersion>4.0.0</modelVersion>

diff --git a/oap-server/ai-pipeline/pom.xml b/oap-server/ai-pipeline/pom.xml
@@ -23,7 +23,7 @@
     <parent>
         <groupId>org.apache.skywalking</groupId>
         <artifactId>oap-server</artifactId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
 
     <groupId>org.apache.skywalking</groupId>

diff --git a/oap-server/analyzer/agent-analyzer/pom.xml b/oap-server/analyzer/agent-analyzer/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>analyzer</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/analyzer/event-analyzer/pom.xml b/oap-server/analyzer/event-analyzer/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>analyzer</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/analyzer/log-analyzer/pom.xml b/oap-server/analyzer/log-analyzer/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <artifactId>analyzer</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/analyzer/meter-analyzer/pom.xml b/oap-server/analyzer/meter-analyzer/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>analyzer</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/analyzer/pom.xml b/oap-server/analyzer/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-server</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/exporter/pom.xml b/oap-server/exporter/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-server</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/mqe-grammar/pom.xml b/oap-server/mqe-grammar/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-server</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/mqe-rt/pom.xml b/oap-server/mqe-rt/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-server</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/oal-grammar/pom.xml b/oap-server/oal-grammar/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-server</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/oal-rt/pom.xml b/oap-server/oal-rt/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-server</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/pom.xml b/oap-server/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>apm</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-alarm-plugin/pom.xml b/oap-server/server-alarm-plugin/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-server</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-cluster-plugin/cluster-consul-plugin/pom.xml b/oap-server/server-cluster-plugin/cluster-consul-plugin/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-cluster-plugin</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-cluster-plugin/cluster-etcd-plugin/pom.xml b/oap-server/server-cluster-plugin/cluster-etcd-plugin/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-cluster-plugin</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-cluster-plugin/cluster-kubernetes-plugin/pom.xml b/oap-server/server-cluster-plugin/cluster-kubernetes-plugin/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-cluster-plugin</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-cluster-plugin/cluster-nacos-plugin/pom.xml b/oap-server/server-cluster-plugin/cluster-nacos-plugin/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <artifactId>server-cluster-plugin</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-cluster-plugin/cluster-standalone-plugin/pom.xml b/oap-server/server-cluster-plugin/cluster-standalone-plugin/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-cluster-plugin</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-cluster-plugin/cluster-zookeeper-plugin/pom.xml b/oap-server/server-cluster-plugin/cluster-zookeeper-plugin/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <groupId>org.apache.skywalking</groupId>
         <artifactId>server-cluster-plugin</artifactId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-cluster-plugin/pom.xml b/oap-server/server-cluster-plugin/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-server</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-configuration/configuration-api/pom.xml b/oap-server/server-configuration/configuration-api/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-configuration</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-configuration/configuration-apollo/pom.xml b/oap-server/server-configuration/configuration-apollo/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-configuration</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-configuration/configuration-consul/pom.xml b/oap-server/server-configuration/configuration-consul/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-configuration</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
 
     <modelVersion>4.0.0</modelVersion>

diff --git a/oap-server/server-configuration/configuration-etcd/pom.xml b/oap-server/server-configuration/configuration-etcd/pom.xml
@@ -20,7 +20,7 @@
     <parent>
         <artifactId>server-configuration</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-configuration/configuration-k8s-configmap/pom.xml b/oap-server/server-configuration/configuration-k8s-configmap/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-configuration</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>configuration-k8s-configmap</artifactId>

diff --git a/oap-server/server-configuration/configuration-nacos/pom.xml b/oap-server/server-configuration/configuration-nacos/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-configuration</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-configuration/configuration-zookeeper/pom.xml b/oap-server/server-configuration/configuration-zookeeper/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-configuration</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-configuration/grpc-configuration-sync/pom.xml b/oap-server/server-configuration/grpc-configuration-sync/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>server-configuration</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-configuration/pom.xml b/oap-server/server-configuration/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-server</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/oap-server/server-core/pom.xml b/oap-server/server-core/pom.xml
@@ -21,7 +21,7 @@
     <parent>
         <artifactId>oap-server</artifactId>
         <groupId>org.apache.skywalking</groupId>
-        <version>10.1.0-SNAPSHOT</version>
+        <version>${revision}</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>