Better deployment

parttimenerd · parttimenerd · commit 71c0c4fabdb3 · 2022-11-09T17:53:38.000+01:00
diff --git a/README.md b/README.md
@@ -2,24 +2,38 @@ Loader for AsyncProfiler
 ========================
 
 Packages [async-profiler](https://github.com/jvm-profiling-tools/async-profiler) releases in a JAR
-with a `AsyncProfilerLoader` (version 2+) that loads the suitable native library for the current platform.
+with an `AsyncProfilerLoader` (version 2+) that loads the suitable native library for the current platform.
 
 This is usable as a java agent (same arguments as the async-profiler agent) and as the basis for other libraries.
 The real rationale behind this library is that the async-profiler is a nice tool, but it cannot be easily integrated
-into other Java based tools.
+into other Java-based tools.
 
 The wrapper is tested against all relevant tests of the async-profiler tool, ensuring that it has the same behavior.
 
-Take the `all` build and you have a JAR that provides the important features of async-profiler on all supported
+Take the [`all` build](https://github.com/parttimenerd/ap-loader/releases/latest/download/ap-loader-all.jar) and you have a JAR that provides the important features of async-profiler on all supported
 platforms.
 
-A changelog can be found at the async-profiler repository, as this library should rarely change itself.
+A changelog can be found in the async-profiler repository, as this library should rarely change itself.
 
 _This project assumes that you used async-profiler before, if not, don't worry, you can still use this project,
-but be aware that it's documentation refers you to the async-profiler documentation a lot._
+but be aware that its documentation refers you to the async-profiler documentation a lot._
 
 _fdtransfer is currently not supported, feel free to create an issue if you need it._
 
+Download
+--------
+
+You can download the latest release from the 
+[latest release page](https://github.com/parttimenerd/ap-loader/releases/latest/).
+As a shortcut, the wrapper for all platforms can be found 
+[here](https://github.com/parttimenerd/ap-loader/releases/latest/download/ap-loader-all.jar).
+
+It should be up to date with the latest async-profiler release, but if not, feel free to create an issue.
+
+To use the library as a dependency, you can depend on `me.bechberger.ap-loader:<version>-<variant>-SNAPSHOT`
+from the [Sonatype OSS repository](https://s01.oss.sonatype.org/content/repositories/snapshots). 
+See [#usage-in-java-code](Usage in Java Code) for more information. 
+
 Supported Platforms
 -------------------
 
@@ -33,6 +47,8 @@ The JAR can be obtained in the following variants:
 - `macos`, `linux-x64`, ...: `jattach`, `profiler.sh` and `libasyncProfiler.so` for the given platform
 - `all`: all of the above
 
+Regarding file sizes: The `all` variant are typically around 800KB and the individual variants around 200 to 400KB.
+
 Commands
 --------
 
@@ -42,7 +58,7 @@ Be aware that it is recommended to use run the JVM with the
 `-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints` flags.
 This improves the accuracy of the profiler.
 
-Overview over the commands:
+Overview of the commands:
 
 ```sh
 Usage: java -jar ap-loader.jar <command> [args]
@@ -81,7 +97,7 @@ See the [GitHub page of jattach](https://github.com/apangin/jattach) for more de
 `java -jar ap-loader.jar profiler` is equivalent to calling the suitable `profiler.sh`:
 
 ```sh
-# Profile a process for a `n` seconds
+# Profile a process for `n` seconds
 java -jar ap-loader.jar profiler -d <n> <pid>
 
 # Profile a process for allocation, CPU and lock events and save the results to a JFR file
@@ -122,17 +138,17 @@ Running as an agent
 -------------------
 
 `java -javaagent:ap-loader.jar=<options>` is equivalent to `java -agentpath:libasyncProfiler.so=<options>`
-with the suitable library.
+with a suitable library.
 This can be used to profile a Java process from the start.
 
 ```sh
-# Profile the application and output a flamegraph
-java -javaagent:/path/to/libasyncProfiler.so=start,event=cpu,file=profile.html <java arguments>
+# Profile the application and output a flame graph
+java -javaagent:ap-loader.jar=start,event=cpu,file=profile.html <java arguments>
 ```
 
 See the [GitHub page of async-profiler](https://github.com/jvm-profiling-tools/async-profiler) for more details.
 
-Using in Java code
+Usage in Java Code
 ------------------
 
 Then you can use the `AsyncProfilerLoader` class to load the native library:
@@ -145,25 +161,23 @@ AsyncProfiler profiler = one.profiler.AsyncProfilerLoader.load();
 the [main API class](https://github.com/jvm-profiling-tools/async-profiler/blob/master/src/api/one/profiler/AsyncProfiler.java)
 from the async-profiler.jar.
 
-The API of the `AsyncProfilerLoader` can be used to execute all commands the CLI programmatically.
+The API of the `AsyncProfilerLoader` can be used to execute all commands of the CLI programmatically.
 
-### Snapsshots
+### Snapshots
 
-We currently only release to snapshop, as the API is not stable yet.
+We currently only release to snapshot, as the API is not stable yet.
 
 ```xml
-
 <dependency>
     <groupId>me.bechberger</groupId>
     <artifactId>ap-loader</artifactId>
     <version>version-variant-SNAPSHOT</version>
 </dependency>
 ```
 
-For example for the all variant of version 2.8.3:
+For example for the `all` variant of version 2.8.3:
 
 ```xml
-
 <dependency>
     <groupId>me.bechberger</groupId>
     <artifactId>ap-loader</artifactId>
diff --git a/bin/copy_java_file.sh b/bin/copy_java_file.sh
@@ -0,0 +1,13 @@
+#! /bin/sh
+# ./copy_java_file.sh <base_dir> <artifact version, like 2.8.3-all>
+
+set -e
+
+OWN_DIR=$(dirname "$0")
+
+# extract the version without the platform suffix
+version=$(echo "$2" | cut -d '-' -f 1)
+echo "version: $version"
+cd "$1" || exit 1
+
+cp ap-releases/async-profiler-$version-code/src/api/one/profiler/*.java src/main/java/one/profiler
diff --git a/bin/releaser.py b/bin/releaser.py
@@ -7,10 +7,12 @@
 It has no dependencies, only requiring Python 3.6+ to be installed.
 """
 import sys
+import tempfile
 import traceback
 import os
 import shutil
 import subprocess
+from pathlib import Path
 from urllib import request
 from typing import Any, Dict, List, Union, Tuple, Optional
 import json
@@ -26,7 +28,10 @@
     download          download and prepare the folders for the given release
     build             build the wrappers for the given release
     test              test the given release
-    deploy            deploy the wrappers for the given release, i.e., use "mvn deploy"
+    deploy_mvn        deploy the wrappers for the given release as a snapshot to maven
+    deploy_gh         deploy the wrappers for the given release as a snapshot to GitHub
+    deploy            deploy the wrappers for the given release as a snapshot
+    deploy_release    deploy the wrappers for the given release
     clear             clear the ap-releases and target folders for a fresh start
 
 Environment variables:
@@ -282,6 +287,74 @@ def test_release(release: str):
         test_release_for_java(release)
 
 
+def deploy_maven_platform(release: str, platform: str, snapshot: bool):
+    print(f"Deploy {release} for {platform} to maven")
+    pom = "pom_all.xml" if platform == "all" else "pom.xml"
+    cmd = f"mvn -Dproject.versionPlatform='{release}-{platform}' -Dproject.suffix='{'-SNAPSHOT' if snapshot else ''}' -f {pom} clean deploy"
+    try:
+        subprocess.check_call(cmd, shell=True, cwd=CURRENT_DIR, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+    except subprocess.CalledProcessError:
+        os.system(
+            f"cd {CURRENT_DIR}; {cmd}")
+        raise
+
+
+def deploy_maven(release: str, snapshot: bool = True):
+    print(f"Deploy {release}{' snapshot' if snapshot else ''}")
+    for platform in get_release_platforms(release):
+        deploy_maven_platform(release, platform, snapshot)
+    deploy_maven_platform(release, "all", snapshot)
+
+
+def get_changelog(release: str) -> str:
+    url = get_release(release)["html_url"]
+    return f"_Copied from the wrapped [async-profiler release]({url}) by [Andrei Pangin](https://github.com/apangin). " \
+           f"The source code linked below should be ignored._\n\n{get_release_info(release)}"
+
+
+def deploy_github(release: str):
+    changelog = get_changelog(release)
+    is_latest = release == get_most_recent_release()
+    title = f"Loader for {release}: {get_release(release)['name']}"
+    prerelease = get_release(release)["prerelease"]
+    print(f"Deploy {release} ({title}) to GitHub")
+    if not os.path.exists(f"{CURRENT_DIR}/releases/ap-loader-{release}-all.jar"):
+        build_release(release)
+    with tempfile.TemporaryDirectory() as d:
+        changelog_file = f"{d}/CHANGELOG.md"
+        with open(changelog_file, "w") as of:
+            of.write(changelog)
+            of.close()
+        releases_dir = f"{CURRENT_DIR}/releases"
+        platform_paths = []
+        for platform in get_release_platforms(release) + ["all"]:
+            path = f"{d}/ap-loader-{platform}.jar"
+            shutil.copy(f"{releases_dir}/ap-loader-{release}-{platform}.jar", path)
+            platform_paths.append(path)
+
+        flags_str = f"-F {changelog_file} -t '{title}' {'--latest' if is_latest else ''}" \
+              f" {'--prerelease' if prerelease else ''}"
+        paths_str = " ".join(f'"{p}"' for p in platform_paths)
+        cmd = f"gh release create {release} {flags_str} {paths_str}"
+        try:
+            subprocess.check_call(cmd, shell=True, cwd=CURRENT_DIR, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        except subprocess.CalledProcessError:
+            # this is either a real problem or it means that the release already exists
+            # in the latter case, we can just update it
+            cmd = f"gh release edit {release} {flags_str}; gh release upload {release} {paths_str} --clobber"
+            try:
+                subprocess.check_call(cmd, shell=True, cwd=CURRENT_DIR, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+            except subprocess.CalledProcessError:
+                os.system(
+                    f"cd {CURRENT_DIR}; {cmd}")
+
+
+
+def deploy(release: str, snapshot: bool = True):
+    deploy_maven(release, snapshot)
+    deploy_github(release)
+
+
 def clear():
     shutil.rmtree(f"{CURRENT_DIR}/ap-releases", ignore_errors=True)
     shutil.rmtree(f"{CURRENT_DIR}/releases", ignore_errors=True)
@@ -291,8 +364,8 @@ def clear():
 
 
 def parse_cli_args() -> Tuple[List[str], Optional[str]]:
-    available_commands = ["current_version", "versions", "download", "build", "test", "deploy",
-                          "deploy-release", "clear"]
+    available_commands = ["current_version", "versions", "download", "build", "test", "deploy_mvn", "deploy_gh", "deploy",
+                          "deploy_release", "clear"]
     commands = []
     release = sys.argv[-1] if sys.argv[-1][0].isnumeric() else None
     for arg in sys.argv[1:(-1 if release else None)]:
@@ -316,6 +389,10 @@ def cli():
         "download": lambda: download_release(release),
         "build": lambda: build_release(release),
         "test": lambda: test_release(release),
+        "deploy_mvn": lambda: deploy_maven(release),
+        "deploy_gh": lambda: deploy_github(release),
+        "deploy": lambda: deploy(release, snapshot=True),
+        "deploy_release": lambda: deploy(release, snapshot=False),
         "clear": clear,
     }
     for command in commands:
diff --git a/pom.xml b/pom.xml
@@ -4,9 +4,11 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
+    <name>ap-loader</name>
     <groupId>me.bechberger</groupId>
     <artifactId>ap-loader</artifactId>
     <version>${project.versionPlatform}${project.suffix}</version>
+    <url>https://github.com/parttimenerd/ap-loader</url>
     <licenses>
         <license>
             <name>Apache License, Version 2.0</name>
@@ -120,7 +122,7 @@
                     <descriptorRefs>
                         <descriptorRef>jar-with-dependencies</descriptorRef>
                     </descriptorRefs>
-                    <finalName>${artifactId}-${project.versionPlatform}-full</finalName>
+                    <finalName>${project.artifactId}-${project.versionPlatform}-full</finalName>
                     <appendAssemblyId>false</appendAssemblyId>
                 </configuration>
             </plugin>
@@ -137,6 +139,23 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.4.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadoc</id>
+                        <phase>deploy</phase>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <additionalJOption>-Xdoclint:none</additionalJOption>
+                </configuration>
+            </plugin>
             <plugin>
                 <artifactId>maven-deploy-plugin</artifactId>
                 <version>2.8.2</version>
@@ -151,16 +170,46 @@
                 </executions>
             </plugin>
             <plugin>
-                <groupId>org.simplify4u.plugins</groupId>
-                <artifactId>sign-maven-plugin</artifactId>
-                <version>1.0.1</version>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-gpg-plugin</artifactId>
+                <version>1.6</version>
                 <executions>
                     <execution>
+                        <id>sign-artifacts</id>
+                        <phase>verify</phase>
                         <goals>
                             <goal>sign</goal>
                         </goals>
                     </execution>
                 </executions>
+                <configuration>
+                    <keyname>${gpg.keyname}</keyname>
+                    <passphrase>${gpg.passphrase}</passphrase>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-deploy-plugin</artifactId>
+                <version>2.8.2</version>
+                <executions>
+                    <execution>
+                        <id>default-deploy</id>
+                        <phase>deploy</phase>
+                        <goals>
+                            <goal>deploy</goal>
+                        </goals>
+                        <configuration>
+                            <skip>true</skip>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>release</id>
+                        <phase>deploy</phase>
+                        <goals>
+                            <goal>deploy</goal>
+                        </goals>
+                    </execution>
+                </executions>
             </plugin>
         </plugins>
     </build>
diff --git a/pom_all.xml b/pom_all.xml
diff --git a/src/main/java/one/profiler/AsyncProfilerLoader.java b/src/main/java/one/profiler/AsyncProfilerLoader.java
