Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ body:
attributes:
label: Schema revision or commit
description: Identify the schema revision, release tag, or commit where the problem occurs.
placeholder: "Schema revision 1 or commit SHA"
placeholder: "Schema revision 2 or commit SHA"

- type: textarea
id: current-behavior
Expand Down
7 changes: 4 additions & 3 deletions .github/workflows/buf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,16 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6

- name: Lint schema
uses: bufbuild/buf-action@v1
uses: bufbuild/buf-action@fd21066df7214747548607aaa45548ba2b9bc1ff # v1
with:
version: "1.71.0"
lint: true
format: false
breaking: false
breaking: true
breaking_against: "https://github.com/ai-dynamo/openengine/archive/d0f29fec31f31db5cfd49cf3e0f67da84d10c709.tar.gz#strip_components=1"
push: false
archive: false
pr_comment: false
137 changes: 137 additions & 0 deletions .github/workflows/packages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
name: Packages

on:
push:
branches:
- main
paths:
- "proto/**"
- "packages/**"
- "tools/rust-codegen/**"
- "scripts/**"
- "Cargo.toml"
- "Cargo.lock"
- ".github/workflows/packages.yml"
- ".github/workflows/release.yml"
pull_request:
paths:
- "proto/**"
- "packages/**"
- "tools/rust-codegen/**"
- "scripts/**"
- "Cargo.toml"
- "Cargo.lock"
- ".github/workflows/packages.yml"
- ".github/workflows/release.yml"

permissions:
contents: read

jobs:
generated:
name: Generated bindings
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6

- name: Set up Python
uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
with:
python-version: "3.14"

- name: Set up Rust
uses: dtolnay/rust-toolchain@fa04a1451ff1842e2626ccb99004d0195b455a88 # master, 2026-07-12
with:
toolchain: stable

- name: Install Python generator
run: python -m pip install grpcio-tools==1.81.1

- name: Check generated bindings
run: ./scripts/check-generated.sh

python:
name: Python ${{ matrix.python-version }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.10", "3.14"]
steps:
- name: Check out repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6

- name: Set up Python
uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
with:
python-version: ${{ matrix.python-version }}

- name: Install build tools
run: python -m pip install build==1.3.0 twine==6.2.0

- name: Build distributions
run: python -m build packages/python --outdir dist/python

- name: Check distribution metadata
run: python -m twine check dist/python/*

- name: Check Python package contents
run: python scripts/check_package_contents.py --python-only

- name: Install wheel
run: python -m pip install dist/python/*.whl

- name: Test installed bindings
run: python -m unittest discover --start-directory packages/python/tests

rust:
name: Rust ${{ matrix.toolchain }}
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
toolchain: ["1.88.0", "stable"]
steps:
- name: Check out repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6

- name: Set up Rust
uses: dtolnay/rust-toolchain@fa04a1451ff1842e2626ccb99004d0195b455a88 # master, 2026-07-12
with:
toolchain: ${{ matrix.toolchain }}

- name: Test crate
run: cargo test --locked --package openengine-proto

- name: Build packaged crate
run: cargo package --locked --package openengine-proto

- name: List packaged files
run: cargo package --locked --package openengine-proto --list

- name: Check Rust package contents
run: python scripts/check_package_contents.py --rust-only

interoperability:
name: Python and Rust interoperability
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6

- name: Set up Python
uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
with:
python-version: "3.14"

- name: Set up Rust
uses: dtolnay/rust-toolchain@fa04a1451ff1842e2626ccb99004d0195b455a88 # master, 2026-07-12
with:
toolchain: stable

- name: Install Python package
run: python -m pip install ./packages/python

- name: Test both serialization directions
run: ./scripts/test-cross-language.sh
119 changes: 119 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
name: Release

on:
push:
tags:
- "v[0-9]+.[0-9]+.[0-9]+"

permissions:
contents: read

jobs:
build:
name: Build and verify release
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6

- name: Set up Python
uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
with:
python-version: "3.14"

- name: Set up Rust
uses: dtolnay/rust-toolchain@fa04a1451ff1842e2626ccb99004d0195b455a88 # master, 2026-07-12
with:
toolchain: stable

- name: Check release versions
run: python scripts/check_release_version.py "${GITHUB_REF_NAME}"

- name: Lint schema
uses: bufbuild/buf-action@fd21066df7214747548607aaa45548ba2b9bc1ff # v1
with:
version: "1.71.0"
lint: true
format: false
breaking: true
breaking_against: "https://github.com/ai-dynamo/openengine/archive/d0f29fec31f31db5cfd49cf3e0f67da84d10c709.tar.gz#strip_components=1"
push: false
archive: false
pr_comment: false

- name: Install Python tools
run: >-
python -m pip install
build==1.3.0
grpcio-tools==1.81.1
twine==6.2.0

- name: Check generated bindings
run: ./scripts/check-generated.sh

- name: Test Rust crate
run: cargo test --locked --package openengine-proto

- name: Build Rust crate
run: cargo package --locked --package openengine-proto

- name: Build Python distributions
run: python -m build packages/python --outdir dist/python

- name: Check Python distributions
run: python -m twine check dist/python/*

- name: Check package contents
run: python scripts/check_package_contents.py

- name: Install and test Python wheel
run: |
python -m pip install dist/python/*.whl
python -m unittest discover --start-directory packages/python/tests

- name: Test cross-language serialization
run: ./scripts/test-cross-language.sh

- name: Assemble release artifacts
run: |
mkdir -p dist/release
cp dist/python/* dist/release/
cp target/package/openengine-proto-*.crate dist/release/
cp packages/rust/openengine-proto/src/generated/openengine_descriptor.bin \
"dist/release/openengine-${GITHUB_REF_NAME}-descriptor.bin"
tar --create --gzip \
--file "dist/release/openengine-${GITHUB_REF_NAME}-proto.tar.gz" \
--directory proto \
openengine
cd dist/release
sha256sum openengine* > SHA256SUMS

- name: Upload release artifacts
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
with:
name: openengine-${{ github.ref_name }}
path: dist
if-no-files-found: error

github-release:
name: Create GitHub release
needs: build
runs-on: ubuntu-latest
permissions:
actions: read
contents: write
steps:
- name: Download release artifacts
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4
with:
name: openengine-${{ github.ref_name }}
path: dist

- name: Create release
env:
GH_TOKEN: ${{ github.token }}
run: >-
gh release create "${GITHUB_REF_NAME}"
dist/release/*
--generate-notes
--title "OpenEngine ${GITHUB_REF_NAME}"
10 changes: 7 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
__pycache__/
*.py[cod]

# Ignore generated Python gRPC stubs if the README example is run locally.
*_pb2.py
*_pb2_grpc.py
# Local Python environments and package artifacts
.venv/
*.egg-info/
dist/

# Rust build artifacts
target/
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--
SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
-->

# Changelog

All notable changes to the OpenEngine schema and generated packages are
documented here. OpenEngine uses the same version for its Git tag, Python
distribution, and Rust crate.

## [Unreleased]

## [0.2.0] - 2026-07-12

### Added

- Generated Python protobuf and gRPC bindings.
- Generated Rust Prost and Tonic client/server bindings.
- Reproducible code generation, package CI, and tag-driven releases.
- Revision-2 multimodal capability discovery and per-request media options.

[Unreleased]: https://github.com/ai-dynamo/openengine/commits/main
[0.2.0]: https://github.com/ai-dynamo/openengine/releases/tag/v0.2.0
28 changes: 27 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,33 @@ sending a PR.
- **Bugs / feedback / design questions**: open a [GitHub issue](https://github.com/ai-dynamo/openengine/issues).
- **Pull requests**: open against `main`. Keep changes focused (one logical change per PR).

## Signing Your Work
## Development checks

The schema under `proto/openengine/v1/` is the source of truth. Generated Python
and Rust bindings are checked in for package consumers and must be updated in
the same pull request as a schema change.

```bash
buf build
buf lint

python -m pip install build==1.3.0 grpcio-tools==1.81.1 twine==6.2.0
./scripts/generate-python.sh
./scripts/generate-rust.sh
./scripts/check-generated.sh

cargo test --locked --package openengine-proto
cargo package --allow-dirty --locked --package openengine-proto
python -m build packages/python --outdir dist/python
python -m twine check dist/python/*
python scripts/check_package_contents.py
./scripts/test-cross-language.sh
```

The Python generator and Rust code-generation toolchain are pinned. Do not edit
generated files by hand; update the schema or generator and regenerate them.

## Signing your work

We require that all contributors "sign off" on their commits. This certifies that
you wrote the contribution, or otherwise have the right to submit it under the
Expand Down
Loading
Loading