mirror of
https://github.com/OpenHands/OpenHands.git
synced 2026-10-07 14:58:39 +08:00
Rohit Malhotraandopenhands
4738f5b7c6
* Add npm publish workflow and release infrastructure - Add .github/workflows/npm-publish.yml for automated npm publishing on GitHub releases - Update CI to verify library build (npm run build:lib) and package contents - Add CHANGELOG.md for version history tracking - Update README.md with npm installation and usage documentation Closes #197 Co-authored-by: openhands <openhands@all-hands.dev> * correct package version * chore: update npm-publish workflow for trusted publishing - Remove NODE_AUTH_TOKEN secret dependency - Keep id-token: write permission for OIDC - Add provenance flag for npm attestations - Add comment explaining trusted publisher setup on npmjs.com Co-authored-by: openhands <openhands@all-hands.dev> * feat: add CLI entry point for npx execution - Add bin/agent-canvas.mjs as executable CLI - Add bin field to package.json for npm bin linking - Include bin/ and build/ directories in published files - CLI serves the built application with SPA routing support - Supports --port, --host, and --help options Co-authored-by: openhands <openhands@all-hands.dev> * refactor: consolidate npm executable to use dev-docker infrastructure - bin/agent-canvas.mjs now uses dev-with-automation.mjs main() with dev-docker.mjs's Docker-specific agent-server starter - Added --static and --static-dir support to dev-with-automation.mjs so the npm executable serves pre-built static assets instead of Vite - Added startStaticFrontend() function that uses static-server.mjs - npm executable runs full stack: Docker agent-server + uvx automation backend + static frontend + ingress proxy Co-authored-by: openhands <openhands@all-hands.dev> * fix: include scripts/ in npm package files The bin/agent-canvas.mjs executable imports from scripts/dev-with-automation.mjs and scripts/dev-docker.mjs, so the scripts directory must be included in the published package. Co-authored-by: openhands <openhands@all-hands.dev> * fix: address review comments - Fix CHANGELOG.md version mismatch: 1.6.0 -> 1.0.0-alpha.1 to match package.json - Add NODE_AUTH_TOKEN env var to npm-publish workflow for authentication - Add CLI entry point mention to CHANGELOG Co-authored-by: openhands <openhands@all-hands.dev> * fix: use OIDC trusted publishing (no NPM_TOKEN needed) npm trusted publishing with OIDC doesn't require NODE_AUTH_TOKEN. Instead it uses short-lived OIDC tokens generated by GitHub Actions. Requirements: - id-token: write permission (already set) - npm CLI 11.5.1+ (added npm install -g npm@latest step) - Trusted publisher configured on npmjs.com See: https://docs.npmjs.com/trusted-publishers/ Co-authored-by: openhands <openhands@all-hands.dev> * chore: bump version to 1.0.0-alpha.2 Co-authored-by: openhands <openhands@all-hands.dev> * Build app assets before npm publish Co-authored-by: openhands <openhands@all-hands.dev> * fix: use Node 24 for npm trusted publishing Trusted publishing requires Node 22.14.0+ and npm 11.5.1+. Node 24 ships with npm 11.x which meets the requirement. Node 22.12.0 (previous) ships with npm 10.x which doesn't support OIDC. Also removed the manual npm upgrade step since Node 24 includes a compatible npm version by default. Co-authored-by: openhands <openhands@all-hands.dev> * chore: align all workflows to Node 24 and regenerate lockfile - Update ci.yml to use Node 24 - Update sdk-version-sync.yml to use Node 24 - Regenerate package-lock.json with npm 11.12.1 All workflows now use Node 24 which ships with npm 11.x, required for OIDC trusted publishing (npm 11.5.1+). Co-authored-by: openhands <openhands@all-hands.dev> * fix: remove incorrect LLM env vars from CLI help LLM_MODEL and LLM_API_KEY were listed in the help text but aren't actually used by the scripts. LLM settings are configured through the web UI settings page instead. Co-authored-by: openhands <openhands@all-hands.dev> * fix: address PR review feedback Critical fixes: - Guard prepare script to only run in dev context (check for ../.git) - Add missing existsSync import in dev-with-automation.mjs Workflow improvements: - Update checkout/setup-node actions to v6 for consistency - Add npm version validation (must be 11.5.1+ for trusted publishing) - Add package version validation (must match release tag) CLI improvements: - Add try-catch for dynamic imports with helpful error message - Use console.error directly instead of imported logError/c Documentation: - Fix README export names: ChatInterface→ChatPanel, Terminal→TerminalPanel - Add dist/ to .gitignore Co-authored-by: openhands <openhands@all-hands.dev> * ci: trigger npm publish on tag push instead of release Simpler workflow - just push a tag like v1.0.0-alpha.2 to publish. Co-authored-by: openhands <openhands@all-hands.dev> * chore: remove tarball and add *.tgz to gitignore Co-authored-by: openhands <openhands@all-hands.dev> * fix: npm publish errors 1. Fix bin path - remove './' prefix (npm pkg fix) 2. Add --tag for prerelease versions (alpha/beta/rc) Co-authored-by: openhands <openhands@all-hands.dev> * fix: add repository field for npm provenance verification npm provenance requires repository.url to match the GitHub Actions source. Also added description, homepage, and bugs fields. Co-authored-by: openhands <openhands@all-hands.dev> --------- Co-authored-by: openhands <openhands@all-hands.dev>
78 lines
2.4 KiB
YAML
78 lines
2.4 KiB
YAML
name: SDK Version Sync
|
|
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
# Only run on PRs that touch version-related files
|
|
- "scripts/dev-safe.mjs"
|
|
- "scripts/dev-with-automation.mjs"
|
|
- "scripts/check-sdk-version-sync.mjs"
|
|
- ".github/workflows/sdk-version-sync.yml"
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- "scripts/dev-safe.mjs"
|
|
- "scripts/dev-with-automation.mjs"
|
|
- "scripts/check-sdk-version-sync.mjs"
|
|
- ".github/workflows/sdk-version-sync.yml"
|
|
|
|
# Triggered by external repos (e.g., OpenHands/automation) when SDK deps change
|
|
# To trigger: POST /repos/{owner}/{repo}/dispatches with event_type: "sdk-version-check"
|
|
repository_dispatch:
|
|
types: [sdk-version-check, sdk-release]
|
|
|
|
# Triggered when new SDK packages are released on PyPI
|
|
# The OpenHands/software-agent-sdk repo can trigger this on release
|
|
workflow_dispatch:
|
|
inputs:
|
|
sdk_version:
|
|
description: "New SDK version to check against (optional)"
|
|
required: false
|
|
type: string
|
|
|
|
schedule:
|
|
# Run every 6 hours to catch upstream changes reasonably quickly
|
|
- cron: "0 */6 * * *"
|
|
|
|
concurrency:
|
|
group: sdk-sync-${{ github.workflow }}-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
check-sdk-versions:
|
|
name: Check SDK version consistency
|
|
runs-on: ubuntu-24.04
|
|
timeout-minutes: 5
|
|
|
|
steps:
|
|
- name: Check out repository
|
|
uses: actions/checkout@v6
|
|
|
|
- name: Set up Node.js
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version: '24'
|
|
|
|
- name: Log trigger info
|
|
run: |
|
|
echo "Triggered by: ${{ github.event_name }}"
|
|
if [ "${{ github.event_name }}" = "repository_dispatch" ]; then
|
|
echo "Event type: ${{ github.event.action }}"
|
|
echo "Client payload: ${{ toJson(github.event.client_payload) }}"
|
|
fi
|
|
if [ -n "${{ inputs.sdk_version }}" ]; then
|
|
echo "SDK version input: ${{ inputs.sdk_version }}"
|
|
fi
|
|
|
|
- name: Check SDK version sync
|
|
run: node scripts/check-sdk-version-sync.mjs
|
|
env:
|
|
# Pass the SDK version from workflow_dispatch or repository_dispatch if provided
|
|
# workflow_dispatch: uses inputs.sdk_version
|
|
# repository_dispatch: uses client_payload.version
|
|
EXPECTED_SDK_VERSION: ${{ inputs.sdk_version || github.event.client_payload.version || '' }}
|