HPI_RE Continous Build Tracking

README.md

@@ -164,20 +164,22 @@ jobs:
 
 ## Options
 
-| Name            | Default  | Description |
-|-----------------|:--------:|-------------|
-| `java-version`<br>*(required)* | n/a | `'21'` or `'17.0.7'` for a specific Java version, `'dev'` for a dev build with the latest Java version available.<br>(`'8'`, `'11'`, `'16'`, `'19'` are supported for older GraalVM releases.) |
-| `distribution`  | `''` | GraalVM distribution (`graalvm` for Oracle GraalVM, `graalvm-community` for GraalVM Community Edition, `mandrel` for Mandrel). |
-| `github-token`  | `'${{ github.token }}'` | Token for communication with the GitHub API. Please set this to `${{ secrets.GITHUB_TOKEN }}` (see [templates](#templates)) to allow the action to authenticate with the GitHub API, which helps reduce rate-limiting issues. |
-| `set-java-home` | `'true'` | If set to `'true'`, instructs the action to set `$JAVA_HOME` to the path of the GraalVM installation. Overrides any previous action or command that sets `$JAVA_HOME`. |
-| `cache`         | `''`     | Name of the build platform to cache dependencies. Turned off by default (`''`). It can also be `'maven'`, `'gradle'`, or `'sbt'` and works the same way as described in [actions/setup-java][setup-java-caching]. |
-| `check-for-updates` | `'true'`  | [Annotate jobs][gha-annotations] with update notifications, for example when a new GraalVM release is available. |
-| `native-image-musl` | `'false'` | If set to `'true'`, sets up [musl] to build [static binaries][native-image-static] with GraalVM Native Image *(Linux only)*. [Example usage][native-image-musl-build] (be sure to replace `uses: ./` with `uses: graalvm/setup-graalvm@v1`). |
-| `native-image-job-reports` *) | `'false'` | If set to `'true'`, post a job summary containing a Native Image build report. |
-| `native-image-pr-reports`  *) | `'false'` | If set to `'true'`, post a comment containing a Native Image build report on pull requests. Requires `write` permissions for the [`pull-requests` scope][gha-permissions]. |
-| `components`    | `''`     | Comma-separated list of GraalVM components (e.g., `native-image` or `ruby,nodejs`) that will be installed by the [GraalVM Updater][gu]. |
-| `version` | `''` | `X.Y.Z` (e.g., `22.3.0`) for a specific [GraalVM release][releases] up to `22.3.2`<br>`mandrel-X.Y.Z.W` or `X.Y.Z.W-Final` (e.g., `mandrel-21.3.0.0-Final` or `21.3.0.0-Final`) for a specific [Mandrel release][mandrel-releases],<br>`mandrel-latest` or `latest` for the latest Mandrel stable release. |
-| `gds-token`     | `''`     | Download token for the GraalVM Download Service. If a non-empty token is provided, the action will set up GraalVM Enterprise Edition (see [GraalVM EE template](#template-for-graalvm-enterprise-edition)). |
+| Name                                       |         Default         | Description                                                                                                                                                                                                                                                                                                                                                                                                            |
+|--------------------------------------------|:-----------------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `java-version`<br>*(required)*             |           n/a           | `'21'` or `'17.0.7'` for a specific Java version, `'dev'` for a dev build with the latest Java version available.<br>(`'8'`, `'11'`, `'16'`, `'19'` are supported for older GraalVM releases.)                                                                                                                                                                                                                         |
+| `distribution`                             |          `''`           | GraalVM distribution (`graalvm` for Oracle GraalVM, `graalvm-community` for GraalVM Community Edition, `mandrel` for Mandrel).                                                                                                                                                                                                                                                                                         |
+| `github-token`                             | `'${{ github.token }}'` | Token for communication with the GitHub API. Please set this to `${{ secrets.GITHUB_TOKEN }}` (see [templates](#templates)) to allow the action to authenticate with the GitHub API, which helps reduce rate-limiting issues.                                                                                                                                                                                          |
+| `set-java-home`                            |        `'true'`         | If set to `'true'`, instructs the action to set `$JAVA_HOME` to the path of the GraalVM installation. Overrides any previous action or command that sets `$JAVA_HOME`.                                                                                                                                                                                                                                                 |
+| `cache`                                    |          `''`           | Name of the build platform to cache dependencies. Turned off by default (`''`). It can also be `'maven'`, `'gradle'`, or `'sbt'` and works the same way as described in [actions/setup-java][setup-java-caching].                                                                                                                                                                                                      |
+| `check-for-updates`                        |        `'true'`         | [Annotate jobs][gha-annotations] with update notifications, for example when a new GraalVM release is available.                                                                                                                                                                                                                                                                                                       |
+| `native-image-musl`                        |        `'false'`        | If set to `'true'`, sets up [musl] to build [static binaries][native-image-static] with GraalVM Native Image *(Linux only)*. [Example usage][native-image-musl-build] (be sure to replace `uses: ./` with `uses: graalvm/setup-graalvm@v1`).                                                                                                                                                                           |
+| `native-image-job-reports` *)              |        `'false'`        | If set to `'true'`, post a job summary containing a Native Image build report.                                                                                                                                                                                                                                                                                                                                         |
+| `native-image-pr-reports`  *)              |        `'false'`        | If set to `'true'`, post a comment containing a Native Image build report on pull requests. Requires `write` permissions for the [`pull-requests` scope][gha-permissions].                                                                                                                                                                                                                                             |
+| `native-image-pr-comparison`  *)           |        `'false'`        | If set to `'true'`, post a comment containing a Native Image build report which contains compared value to the pr-base branch on pull requests. Additional post a comment containig graphical comparison on pull requests. Requires `write` permissions for the [`pull-requests` scope][gha-permissions]. To persist build data workflow permission have to be set to `Read and write permissions` on GitHub settings. |
+| `native-image-pr-comparison-parameter`  *) |    `'image details'`    | A comma seperated list, which specifies the values being graphical compared on pull requests. Possible values: (analysis results, image details, resource usage). Requires the 'native-image-pr-comparison' parameter to be true.                                                                                                                                                                                      |
+| `components`                               |          `''`           | Comma-separated list of GraalVM components (e.g., `native-image` or `ruby,nodejs`) that will be installed by the [GraalVM Updater][gu].                                                                                                                                                                                                                                                                                |
+| `version`                                  |          `''`           | `X.Y.Z` (e.g., `22.3.0`) for a specific [GraalVM release][releases] up to `22.3.2`<br>`mandrel-X.Y.Z.W` or `X.Y.Z.W-Final` (e.g., `mandrel-21.3.0.0-Final` or `21.3.0.0-Final`) for a specific [Mandrel release][mandrel-releases],<br>`mandrel-latest` or `latest` for the latest Mandrel stable release.                                                                                                             |
+| `gds-token`                                |          `''`           | Download token for the GraalVM Download Service. If a non-empty token is provided, the action will set up GraalVM Enterprise Edition (see [GraalVM EE template](#template-for-graalvm-enterprise-edition)).                                                                                                                                                                                                            |
 
 **) Make sure that Native Image is used only once per build job. Otherwise, the report is only generated for the last Native Image build.*
 

action.yml

@@ -43,6 +43,14 @@ inputs:
     required: false
     description: 'Post a comment containing a Native Image build report on pull requests.'
     default: 'false'
+  native-image-pr-comparison:
+    required: false
+    description: 'Post a comment containing a comparison between the Native Image of the pr-branch and the pr-base-branch on pull.'
+    default: 'false'
+  native-image-pr-comparison-parameter:
+    required: false
+    description: 'Comma seperated list of values, which should be compared by PR. Possible values: (analysis results, image details, resource usage).'
+    default: 'image details'
   version:
     required: false
     description: 'GraalVM version (release, latest, dev).'