Skip to content

Commit 2d4fab7

Browse files
GitHub CopilotCopilot
andcommitted
docs: clarify release workflow is Node-specific and require bundled deps
- Label the release workflow YAML as a Node.js/TypeScript example and note that other runtimes should substitute their own build steps and paths. - Explicitly state that engines must bundle runtime dependencies into the build output (via a bundler) or include them in the tarball, since the compiled dist/ alone may not be self-contained. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 88b6b75 commit 2d4fab7

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

docs/integration-guide.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -909,7 +909,9 @@ git push origin v1.0.0
909909

910910
### Release Workflow
911911

912-
Add a workflow that triggers on version tags, builds your engine, and attaches the artifact to a GitHub Release:
912+
Add a workflow that triggers on version tags, builds your engine, and attaches the artifact to a GitHub Release.
913+
914+
> **Note:** The example below is for a Node.js/TypeScript engine. If your engine uses a different runtime (Python, Go, Rust, etc.), substitute the appropriate setup, dependency installation, and build steps, and adjust the artifact paths to match your compiled output.
913915
914916
```yaml
915917
# .github/workflows/release.yml
@@ -952,7 +954,7 @@ jobs:
952954
953955
Your release artifact must include `engine.yaml` and everything it references. The `entrypoint` in `engine.yaml` is resolved as a relative path, so any files or directories it points to need to be in the tarball alongside it. For example, if your entrypoint is `node dist/index.js`, then `dist/index.js` (and any of its runtime dependencies) must be present.
954956

955-
The release should be self-contained — the platform should be able to extract it and run the entrypoint without cloning the repo, installing dependencies, or building from source.
957+
The release should be self-contained — the platform should be able to extract it and run the entrypoint without cloning the repo, installing dependencies, or building from source. This means your build output must include all runtime dependencies. For Node.js engines, either use a bundler (e.g., esbuild, webpack, or ncc) to produce a single self-contained file, or include the `node_modules` directory in the tarball. Other runtimes should follow their equivalent strategy — for example, Go and Rust engines can compile to a static binary, while Python engines might vendor dependencies or include a virtual environment.
956958

957959

958960
## Architecture Notes

0 commit comments

Comments
 (0)