A site has two kinds of code: the package (astro-project-site in node_modules, updated by npm) and the
files init copied once (config, CI, Cloudflare files), which are yours and never change by themselves.
The package
Section titled “The package”npm install astro-project-site@latestnpm run build- Read the changelog first. Before 1.0, a minor version (0.1 → 0.2) may change options; the options validator names any option that no longer exists or changed type, so a build tells you what to fix.
- Peer dependencies:
astro^7.3 and@astrojs/starlight^0.43. Upgrade them together with the package when a release raises them (npm install astro@latest @astrojs/starlight@latest). npm run buildruns type checks, the links validator anddocs:check; a green build is a good sign nothing silently changed. Regenerate generated blocks if your generators read package files:npm run docs:gen.
The workflow pin
Section titled “The workflow pin”If you use CI (init --ci), .github/workflows/site.yml calls deploy.yml@v<version>. Move the pin to the release you upgraded to (or its
commit SHA) in the same PR, so CI and package match:
uses: pavelpascari/astro-project-site/.github/workflows/deploy.yml@v0.1.0-beta.0uses: pavelpascari/astro-project-site/.github/workflows/deploy.yml@v0.1.0-beta.1Files init copied
Section titled “Files init copied”wrangler.jsonc, public/_headers, tsconfig.json, src/content.config.ts, docs-gen.config.mjs and the
package.json scripts came from the starter of the version you started with. To see what a newer starter does
differently, generate one next to your site and compare:
npx astro-project-site@beta init /tmp/starter-newdiff -ru --exclude=example --exclude=node_modules /tmp/starter-new . | lessTake what you want (a new _headers rule, a new script); nothing requires the starter’s files to match.
Overrides
Section titled “Overrides”If you override components (components.*) or Starlight components, check them against the release notes: a
built-in component’s props are listed, generated from the source, under Components.
Overrides that wrap the built-ins (import { SiteHeader } from 'astro-project-site/components') pick up fixes
automatically.