---
name: zephyr-astro
description: Configure and deploy Astro sites with zephyr-astro-integration; use
  when adding withZephyr to astro.config integrations, deciding whether an Astro
  app's output can be published, wiring ZE_PUBLIC_* runtime values or deployment
  hooks, publishing a TAP package, or diagnosing why an Astro build did not
  publish.
metadata:
  library: zephyr-astro-integration
  library_version: '1.5.0' # x-release-please-version
  purpose: Publish an Astro site's static build output to Zephyr from Astro's build lifecycle while leaving the site's own integrations and config intact.
  domain: frameworks
  type: core
sources:
  - ZephyrCloudIO/zephyr-packages:**/libs/zephyr-astro-integration/src/index.ts
  - ZephyrCloudIO/zephyr-packages:**/libs/zephyr-astro-integration/src/lib/astro-integration-zephyr.ts
  - ZephyrCloudIO/zephyr-packages:**/libs/zephyr-astro-integration/src/lib/internal/extract-astro-assets-map.ts
  - ZephyrCloudIO/zephyr-packages:**/libs/zephyr-astro-integration/src/lib/__test__/astro-integration-zephyr.spec.ts
  - ZephyrCloudIO/zephyr-packages:**/libs/zephyr-astro-integration/src/lib/internal/__test__/extract-astro-assets-map.spec.ts
  - ZephyrCloudIO/zephyr-packages:**/libs/zephyr-astro-integration/package.json
  - ZephyrCloudIO/zephyr-packages:**/libs/zephyr-astro-integration/README.md
---

# Configure Astro for Zephyr

## Setup

Read the site's existing `astro.config.*`, its `output` mode and adapter, and
the installed `astro` version before editing. Keep its existing integrations
and options. If `zephyr-astro-integration` is missing, install it only when
dependency changes are authorized; it is only needed at build time, so a
development dependency is sufficient.

The installed package declares an `astro` peer of
`^4.0.0 || ^5.15.8 || ^6.4.6 || ^7.0.7` and uses the Vite version that Astro
provides. Add `withZephyr()` as the last entry in `integrations`:

```typescript
import { defineConfig } from 'astro/config';
import mdx from '@astrojs/mdx';
import sitemap from '@astrojs/sitemap';
import { withZephyr } from 'zephyr-astro-integration';

export default defineConfig({
  site: 'https://example.com',
  integrations: [mdx(), sitemap(), withZephyr()],
});
```

Astro runs `astro:build:done` hooks one integration at a time in list order,
and Zephyr uploads from that hook. Listing it last lets files written by
earlier integrations, such as a sitemap, exist before the upload. The default
export is the same `withZephyr` function. Do not add `vite-plugin-zephyr` to
`vite.plugins` as well; the integration already owns publication.

## Module Federation

This integration does not configure Module Federation and does not resolve
`zephyr:dependencies` into remote URLs. Its `mfConfigs` and `federation`
options are publication metadata forwarded unchanged and are required only for
TAP packages. Read [publication details](references/publication.md) before
setting them. The shared `zephyr-module-federation` guide covers the
cross-project host and remote model.

## Static output only

The integration uploads the directory Astro passes to `astro:build:done` and
never sends a server entrypoint or snapshot type. That directory is the client
output, so it publishes a static site. With `output: 'server'` or an adapter,
only client and prerendered files are published; on-demand routes, API
endpoints, and middleware are not. Do not present this integration as an SSR
deployment path, and do not remove the user's adapter to make it fit without
authorization; report the limitation instead.

The integration also loads `ZE_PUBLIC_*` values from the site's `.env` files
and rewrites `import.meta.env.ZE_PUBLIC_*` and `process.env.ZE_PUBLIC_*` reads
so environments can override them after the build. The shared `zephyr-core`
guide covers that model.

## Avoid misleading fixes

- Do not treat a successful `astro build` as publication. Zephyr errors in the
  build hook are logged and the build continues unless `ZE_FAIL_BUILD=true` is
  set; only an invalid `target` throws immediately.
- Do not set `target: 'tap-app'` on an ordinary site. TAP disables the
  `ZE_PUBLIC_*` rewrite and requires paired federation metadata.
- Do not assume source maps are published; `.map` files are skipped for
  ordinary sites.
- Do not put credentials in `ZE_PUBLIC_*`; those values are client-visible.

## Verify completion

Run the authorized build with the site's existing package runner. Confirm the
output directory contains the expected pages and assets, and that Zephyr
reports a successful publication with a version URL. A build without
credentials can establish local output correctness, but not live deployment
success. Report that distinction, and state plainly when server-rendered
routes are outside what was published.

On failure, keep the actionable error and fix the matching configuration. Do
not silently change the site's output mode, suppress errors, or claim a
partial build was deployed.