Deployment

Documentation website

The documentation website lives in docs/website/ and is built with Astro Starlight.

npm run docs:build

GitHub Pages deployment is handled by .github/workflows/deploy-docs.yml. The workflow builds docs/website and uploads the generated dist directory as a Pages artifact.

For GitHub Pages project hosting, the workflow sets:

SITE_BASE_PATH=/varco

Release deployment

Tagged releases are handled by .github/workflows/release.yml. A vX.Y.Z tag must match the versions in custom_components/varco/manifest.json, packages/client/package.json, and bridge/package.json. See Release and versioning.

The release workflow uploads a Home Assistant zip artifact, publishes @varco/client to npm, and publishes the Node bridge Docker image to GHCR as ghcr.io/vekexasia/varco-bridge:<version>.

Home Assistant showcase

The Home Assistant showcase deployment is handled by .github/workflows/deploy-ha-showcase.yml.

The remote showcase path and credentials are configured through GitHub Actions secrets.