chore: release → 1.0.0-alpha7

.gitattributes

@@ -11,6 +11,7 @@ packages/graalvm/src/test/resources/embedded/** -linguist-detectable linguist-ge
 packages/graalvm/src/test/resources/embedded/*.js -linguist-detectable linguist-generated
 packages/graalvm-react/src/main/node/** -linguist-detectable linguist-generated
 packages/graalvm-react/src/main/node/*.js -linguist-detectable linguist-generated
+docs linguist-documentation
 docs/* linguist-documentation
 tools/plugin/gradle-plugin/plugin-build/plugin/src/model/java -linguist-detectable linguist-generated
 tools/plugin/gradle-plugin/plugin-build/plugin/src/model/kotlin -linguist-detectable linguist-generated

.github/CONTRIBUTING.md

@@ -81,3 +81,94 @@ on your change and amend accordingly.
 - `ktlint` is configured as a linter. Your change should pass a `ktlintCheck` job.
 - The Kotlin API validator runs on each PR to ensure we don't break API consumers. You can update API pins with `apiDump` (on the applicable project).
 - We will not accept dependencies with medium or high-severity vulnerabilities
+
+## Reporting bugs
+
+We use [GitHub Issues](https://github.com/elide-dev/elide/issues/new/choose) to track bugs and requests. Please check current issues before submitting to avoid duplicate reports.
+
+## Feature requests and discussions
+
+If your contribution adds a new feature or makes substantial changes to the code, please [start a new GitHub discussion](https://github.com/orgs/elide-dev/discussions/new/choose) explaining the motivation and scope of such changes. You can also reach out through our [Discord server](https://elide.dev/discord) and share your ideas there.
+
+## Contributing with pull requests
+
+If you are opening a Pull Request, you may want to add a quick summary of the changes in the description, as well as add comments in relevant places in the code. This will help our maintainers during code review and increase the chance of the changes being merged.
+
+Opening "draft" Pull Requests is a good idea if you intend to continue working on your branch but still need the feedback provided by automated checks.
+
+#### Conventional commits
+
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to maintain standard commit messages, as well as for Pull Request and Issues.
+
+#### Document your code
+
+Make sure to add documentation comments for your code, especially if it includes public methods or classes that can be exposed to users. The standard guidelines for Kotlin doc comments apply, and we encourage the use of `@param`, `@return`, and `@throws` labels.
+
+#### Write tests
+
+Including tests for your changes is highly recommended, they will run automatically using GitHub Actions, and can provide you with quick feedback even before code review. High code coverage is welcome but not required, as long as the tests cover all relevant changes.
+
+#### Code Review and automated checks
+
+All Pull Requests need to be reviewed by maintainers of the repository before they can be merged. They will also need to pass a series of automated checks (via GitHub Actions), including unit tests, API compatibility checks, and code quality inspection.
+
+Once you are satisfied with your work and want to submit it for review, mark it as "Ready", and a maintainer will take a look to decide whether it will be merged or not, or request additional changes to comply with contribution guidelines.
+
+## Build environment
+
+The following tools are required for local development:
+- [Gradle 8.4](https://gradle.org/releases/) or newer, using the Gradle wrapper will automatically download the correct distribution the first time a task is executed.
+- The latest [GraalVM JDK](https://www.graalvm.org/downloads/) distribution, the `native-image` component is required to build the native CLI distribution.
+
+When working on certain parts of the repository, such as the code samples, you may need to set the value for some properties in your local properties file at `~/.gradle/gradle.properties`:
+
+```properties
+# without this, sample projects will not be included in the build
+buildSamples = true
+```
+
+Check the `gradle.properties` file at the project root to see all available options.
+
+## Building a custom runtime
+
+If you are building a JVM application that runs guest code in one of the languages supported by Elide, you can use the Runtime DSL to configure your own embedded polyglot engine:
+
+```kotlin
+implementation("dev.elide:elide-graalvm:1.0.0-alpha7")
+```
+
+or for Groovy scripts:
+
+```groovy
+implementation 'dev.elide:elide-graalvm:1.0.0-alpha7'
+```
+
+The DSL is used internally by the Elide binaries and by the SSR packages and provides a simplified API to harness the power of the underlying [GraalVM](https://graalvm.org) engine:
+
+```kotlin
+// configure and create a new engine
+val engine = PolyglotEngine {
+  // add support for the JavaScript language
+  install(JavaScript) {
+    // enable ESM support
+    esm = true
+
+    // include custom bindings into the engine, these
+    // will be available as top level symbols
+    bindings {
+      put("version", "1.0.0")
+    }
+  }
+}
+
+// obtain a context to evaluate source code
+val context = engine.acquire()
+
+// evaluate guest JavaScript code
+context.javascript("""
+  console.log(`Hello from custom runtime v${version}`)
+""")
+```
+
+> [!WARNING]
+> The Elide Runtime DSL is intended for advanced use cases, and while we try not to break compatibility between releases, there are no guarantees.

.github/FUNDING.yml

@@ -1,5 +1,2 @@
-# These are supported funding model platforms
-
 github: [sgammon]
-# open_collective: # Replace with a single Open Collective username
-# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+patreon: elide_dev

.github/workflows/bench.ci.yml

@@ -62,7 +62,7 @@ jobs:
           egress-policy: audit
 
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: "Setup: GraalVM"
         uses: graalvm/setup-graalvm@0a27862568a8481fbfd3e2ce38c6445e34c0bed4 # v1.1.4
         if: ${{ matrix.engine == 'graalvm' }}
@@ -85,7 +85,7 @@ jobs:
       - name: "Setup: Yarn"
         run: yarn
       - name: "Run Benchmarks"
-        uses: gradle/gradle-build-action@b5126f31dbc19dd434c3269bf8c28c315e121da2 # v2.8.1
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         id: gradlebench
         continue-on-error: ${{ matrix.experimental }}
         env:

.github/workflows/build.ci.yml

@@ -36,7 +36,7 @@ jobs:
         with:
           egress-policy: audit
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: "Setup: GraalVM (Java 20)"
         uses: elide-dev/setup-graalvm@0711c08964f86c1721bebb824b2ac856457e0f55 # custom
         with:
@@ -78,7 +78,7 @@ jobs:
       - name: "Patch: Restore Yarn Lock"
         run: mv yarn.inert yarn.lock
       - name: "Check: Library ABI"
-        uses: gradle/gradle-build-action@b5126f31dbc19dd434c3269bf8c28c315e121da2 # v2.8.1
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         id: abicheck
         continue-on-error: ${{ contains(github.event.pull_request.labels.*.name, 'ci:api-check-bypass') }}
         env:
@@ -142,7 +142,7 @@ jobs:
         with:
           egress-policy: audit
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: "Setup: GraalVM (Java 20)"
         uses: elide-dev/setup-graalvm@0711c08964f86c1721bebb824b2ac856457e0f55 # custom
         with:
@@ -177,7 +177,7 @@ jobs:
           export_environment_variables: true
           cleanup_credentials: true
       - name: "🛠️ Build"
-        uses: gradle/gradle-build-action@b5126f31dbc19dd434c3269bf8c28c315e121da2 # v2.8.1
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         id: gradlebuild
         continue-on-error: ${{ matrix.mode == 'labs' }}
         env:
@@ -206,7 +206,7 @@ jobs:
             -PbuildDocs=false
       - name: "Build reports"
         if: failure()
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
         with:
           name: build-reports-${{ matrix.os }}-latest-gvm-latest
           path: |
@@ -251,7 +251,7 @@ jobs:
         with:
           egress-policy: audit
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: "Setup: Git History"
         run: git fetch --unshallow || exit 0
       - name: "Setup: GraalVM (Java 20)"
@@ -288,7 +288,7 @@ jobs:
       - name: "Setup: Yarn"
         run: npm install -g yarn@1.22.19 && yarn --ignore-platform
       - name: "Testsuite (JVM)"
-        uses: gradle/gradle-build-action@b5126f31dbc19dd434c3269bf8c28c315e121da2 # v2.8.1
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         env:
           CI: true
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
@@ -316,7 +316,7 @@ jobs:
             -PbuildDocs=false
             -PbuildDocsSite=false
       - name: "Runtime Self-tests (JVM)"
-        uses: gradle/gradle-build-action@b5126f31dbc19dd434c3269bf8c28c315e121da2 # v2.8.1
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         continue-on-error: true
         env:
           CI: true
@@ -341,7 +341,7 @@ jobs:
             -PbuildDocs=false
             -PbuildDocsSite=false
             --args="selftest"
-      - uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+      - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
         with:
           name: test-reports-jvm
           path: |
@@ -404,7 +404,7 @@ jobs:
         with:
           egress-policy: audit
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: "Setup: GraalVM (Java 20)"
         uses: elide-dev/setup-graalvm@0711c08964f86c1721bebb824b2ac856457e0f55 # custom
         with:
@@ -439,7 +439,7 @@ jobs:
       - name: "Setup: Yarn"
         run: npm install -g yarn@1.22.19 && yarn --ignore-platform
       - name: "Run Tests (Native)"
-        uses: gradle/gradle-build-action@b5126f31dbc19dd434c3269bf8c28c315e121da2 # v2.8.1
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         continue-on-error: true
         env:
           CI: true
@@ -461,7 +461,7 @@ jobs:
             -PbuildSamples=false
             -PbuildDocsSite=false
             -PbuildDocs=false
-      - uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+      - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
         with:
           name: test-reports-native
           path: |
@@ -513,7 +513,7 @@ jobs:
         with:
           egress-policy: audit
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - id: "auth"
         name: "Setup: Authorize Service Account"
         uses: google-github-actions/auth@35b0e87d162680511bf346c299f71c9c5c379033 # v1.1.1
@@ -554,7 +554,7 @@ jobs:
       - name: "Setup: Yarn"
         run: npm install -g yarn@1.22.19 && yarn --ignore-platform
       - name: "Build: CLI (Native/Debug)"
-        uses: gradle/gradle-build-action@b5126f31dbc19dd434c3269bf8c28c315e121da2 # v2.8.1
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         env:
           CI: true
         with:
@@ -579,21 +579,21 @@ jobs:
           popd;
           echo "Binary compressed.";
       - name: "Artifacts: Debug Binary (Unix)"
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
         if: success() && !contains(matrix.runner, 'windows')
         with:
           name: cli-debug-${{ matrix.tag }}
           path: |
             ./packages/cli/build/native/nativeCompile/elide.debug.xz
       - name: "Artifacts: Debug Binary (Windows)"
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
         if: success() && contains(matrix.runner, 'windows')
         with:
           name: cli-debug-${{ matrix.tag }}
           path: |
             ./packages/cli/build/native/nativeCompile/elide.debug
       - name: "Artifacts: Dashboard Dump"
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
         if: success()
         with:
           name: cli-debug-report-${{ matrix.tag }}
@@ -646,7 +646,7 @@ jobs:
         with:
           egress-policy: audit
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - id: "auth"
         name: "Setup: Authorize Service Account"
         uses: google-github-actions/auth@35b0e87d162680511bf346c299f71c9c5c379033 # v1.1.1
@@ -686,7 +686,7 @@ jobs:
       - name: "Setup: Yarn"
         run: npm install -g yarn@1.22.19 && yarn --ignore-platform
       - name: "Build: CLI (Native/Release)"
-        uses: gradle/gradle-build-action@b5126f31dbc19dd434c3269bf8c28c315e121da2 # v2.8.1
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         env:
           CI: true
         with:
@@ -705,7 +705,7 @@ jobs:
             -PbuildDocsSite=false
             -PbuildDocs=false
       - name: "Artifacts: Release Binary"
-        uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
         if: success()
         with:
           name: cli-release-${{ matrix.tag }}
@@ -770,12 +770,12 @@ jobs:
       - name: "Setup: QEMU"
         uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3 # v3.0.0
       - name: "Setup: Docker"
-        uses: docker/setup-buildx-action@4c0219f9ac95b02789c1075625400b2acbff50b1 # v2.9.1
+        uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
         id: buildx
         with:
           install: true
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: "Setup: Node"
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
         with:
@@ -808,7 +808,7 @@ jobs:
       ## -- Samples -- ##
       - name: "Build/Push: '${{ matrix.project }}' (JVM)"
         continue-on-error: ${{ fromJson(matrix.labs) }}
-        uses: gradle/gradle-build-action@b5126f31dbc19dd434c3269bf8c28c315e121da2 # v2.8.1
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         with:
           arguments: |
             --no-daemon
@@ -882,12 +882,12 @@ jobs:
       - name: "Setup: QEMU"
         uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3 # v3.0.0
       - name: "Setup: Docker"
-        uses: docker/setup-buildx-action@4c0219f9ac95b02789c1075625400b2acbff50b1 # v2.9.1
+        uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
         id: buildx
         with:
           install: true
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: "Setup: Node"
         uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
         with:
@@ -920,7 +920,7 @@ jobs:
 
       ## -- Samples -- ##
       - name: "Build/Push: '${{ matrix.project }}' (Native)"
-        uses: gradle/gradle-build-action@b5126f31dbc19dd434c3269bf8c28c315e121da2 # v2.8.1
+        uses: gradle/gradle-build-action@842c587ad8aa4c68eeba24c396e15af4c2e9f30a # v2.9.0
         continue-on-error: true
         with:
           arguments: |

.github/workflows/codeql.ci.yml

@@ -32,10 +32,10 @@ jobs:
           egress-policy: audit
 
       - name: Checkout repository
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@00e563ead9f72a8461b24876bee2d0c2e8bd2ee8 # v2.21.5
+        uses: github/codeql-action/init@ddccb873888234080b77e9bc2d4764d5ccaaccf9 # v2.21.9
         with:
           config-file: ./.github/codeql/codeql-config.yml
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@00e563ead9f72a8461b24876bee2d0c2e8bd2ee8 # v2.21.5
+        uses: github/codeql-action/analyze@ddccb873888234080b77e9bc2d4764d5ccaaccf9 # v2.21.9

.github/workflows/copybara.ci.yml

@@ -25,7 +25,7 @@ jobs:
           egress-policy: audit
 
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v3
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v3
       - name: "Migrate: Protocol"
         uses: sgammon/copybara-action@5669453d54072738035b0985cfe322d0ee5de0db
         with:
@@ -58,7 +58,7 @@ jobs:
           egress-policy: audit
 
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v3
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v3
       - name: "Migrate: Cluster"
         uses: sgammon/copybara-action@5669453d54072738035b0985cfe322d0ee5de0db
         with:

.github/workflows/deploy.ci.yml

@@ -85,7 +85,7 @@ jobs:
           egress-policy: audit
 
       - name: "Setup: Checkout"
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
       - name: "Setup: Fly"
         uses: superfly/flyctl-actions/setup-flyctl@5e0688e3d0586e2cad2288e6c49c3e9bedac39e5 # master
       - name: "Deploy: Fly (${{ inputs.environment }})"