Merge pull request #316 from graalvm/ni-demos-refactoring-13

[GR-60094] Refactor and move hello-graal demo to native-image category.

Author: olyagpl

.github/workflows/hello-graal.yml renamed to .github/workflows/native-image-hello-world.yml

@@ -1,26 +1,26 @@
-name: hello-graal
+name: native-image/hello-world
 on:
   push:
     paths:
-      - 'hello-graal/**'
-      - '.github/workflows/hello-graal.yml'
+      - 'native-image/hello-world/**'
+      - '.github/workflows/native-image-hello-world.yml.yml'
   pull_request:
     paths:
-      - 'hello-graal/**'
-      - '.github/workflows/hello-graal.yml'
+      - 'native-image/hello-world/**'
+      - '.github/workflows/native-image-hello-world.yml.yml'
   schedule:
     - cron: "0 0 1 * *" # run every month
   workflow_dispatch:
 permissions:
   contents: read
 jobs:
   run:
-    name: Run 'hello-graal'
+    name: Run 'native-image/hello-world'
     runs-on: ubuntu-latest
     timeout-minutes: 15
     strategy:
       matrix:
-        java-version: ['21', 'dev']
+        java-version: ['21', '24-ea']
     steps:
       - uses: actions/checkout@v4
       - uses: graalvm/setup-graalvm@v1
@@ -29,12 +29,7 @@ jobs:
           distribution: 'graalvm'
           github-token: ${{ secrets.GITHUB_TOKEN }}
           native-image-job-reports: 'true'
-      - name: Run 'hello-graal'
+      - name: Run 'native-image/hello-world'
         run: |
-          cd hello-graal
-          javac -d build src/com/hello/Graal.java
-          java -cp ./build com.hello.Graal
-          jar cfvm Hello.jar manifest.txt -C build .
-          jar tf Hello.jar
-          native-image -jar Hello.jar
-          ./Hello
+          cd native-image/hello-world
+          ./run.sh

README.md

@@ -28,8 +28,8 @@ cd graalvm-demos
       <td align="left" width="70%">Demonstrates how to build very small Docker container images with GraalVM Native Image and various lightweight base images. <br><strong>Technologies: </strong> Native Image, musl libc<br><strong>Reference: </strong><a href="https://www.graalvm.org/22.0/reference-manual/native-image/StaticImages/">Static and Mostly Static Images</a></td>
     </tr>
     <tr>
-      <td align="left" width="30%"><a href="/hello-graal/">hello-graal</a><br><a href="https://github.com/graalvm/graalvm-demos/actions/workflows/hello-graal.yml"><img alt="hello-graal" src="https://github.com/graalvm/graalvm-demos/actions/workflows/hello-graal.yml/badge.svg" /></a></td>
-      <td align="left" width="70%">Demonstrates how to build native executables from a class file and a JAR file from the command line <br><strong>Technologies: </strong> Native Image <br><strong>Reference: </strong><a href="https://www.graalvm.org/dev/reference-manual/native-image/#build-a-native-executable">Native Image Getting Started</a></td>
+      <td align="left" width="30%"><a href="/native-image/hello-world/">native-image/hello-world</a><br><a href="https://github.com/graalvm/graalvm-demos/actions/workflows/native-image-hello-world.yml"><img alt="native-image/hello-world" src="https://github.com/graalvm/graalvm-demos/actions/workflows/native-image-hello-world.yml/badge.svg" /></a></td>
+      <td align="left" width="70%">Demonstrates how to build native executables from a class file and a JAR file from the command line <br><strong>Technologies: </strong> Native Image <br><strong>Reference: </strong><a href="https://www.graalvm.org/latest/reference-manual/native-image/#build-a-native-executable-using-the-native-image-tool">Native Image Getting Started</a></td>
     </tr>
     <tr>
       <td align="left" width="30%"><a href="/java-hello-world-maven/">java-hello-world-maven</a><br><a href="https://github.com/graalvm/graalvm-demos/actions/workflows/java-hello-world-maven.yml"><img alt="java-hello-world-maven" src="https://github.com/graalvm/graalvm-demos/actions/workflows/java-hello-world-maven.yml/badge.svg" /></a></td>

hello-graal/README.md

@@ -0,0 +1 @@
+HelloWorld

hello-graal/manifest.txt

@@ -0,0 +1,41 @@
+# Build a Native Executable Using the `native-image` Tool
+
+This is a HelloWorld Java example, referenced from [Getting Started with Native Image](https://www.graalvm.org/latest/reference-manual/native-image/).
+  
+## Run the Application from a Class File
+
+1. Compile the application running the follow command:
+    ```bash
+    javac -d build src/com/example/HelloWorld.java
+    ```
+    This generates the `HelloWorld.class` file into `build/com/example` directory.
+
+2. Run the application from a class file:
+    ```bash
+    java -cp ./build com.example.HelloWorld
+    ```
+    It outputs the message "Hello, Native World!".
+
+## Run the Application from JAR
+
+1. Create a JAR for the application, running the follow command:
+    ```bash
+    jar --create --file HelloWorld.jar --main-class com.example.HelloWorld -C build .
+    ```
+2. Run the JAR file:
+    ```bash
+    java -jar HelloWorld.jar
+    ```
+
+## Run the Application as a Native Executable
+
+1. Create a native executable of a JAR file:
+    ```bash
+    native-image -jar HelloWorld.jar
+    ```
+    The executable called `./HelloWorld` will be created in the working directory.
+
+2. Execute it:
+    ```bash
+    ./HelloWorld
+    ```

native-image/hello-world/.gitignore

@@ -0,0 +1,2 @@
+Manifest-version: 1.0
+Main-Class: com.example.HelloWorld

native-image/hello-world/README.md

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -ex
+
+# Run from a class file
+javac -d build src/com/example/HelloWorld.java
+java -cp ./build com.example.HelloWorld
+
+# Run from a JAR file
+jar --create --file HelloWorld.jar --main-class com.example.HelloWorld -C build .
+java -jar HelloWorld.jar
+
+# Run from a native executable
+native-image -jar HelloWorld.jar
+./HelloWorld

native-image/hello-world/manifest.txt

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2023, 2024, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * The Universal Permissive License (UPL), Version 1.0
@@ -38,10 +38,10 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package com.hello;
+package com.example;
 
-public class Graal {
+public class HelloWorld {
     public static void main(String[] args) {
-         System.out.println("hello graal");
+         System.out.println("Hello, Native World!");
     }
 }