Skip to content
🌟 Starlight Starter 🚀

GitHub Action Build

GitHub Action Build is a GitHub Action script that will build the project.

It is best practice to build code changes immediately so that any build problems are quickly identified and resolved. This makes the project more maintainable.

Enabling GitHub Action Build

Section titled “Enabling GitHub Action Build”

When you choose GitHub Action Build as an option, the Starlight project will include a .github/workflows/build.yml file. It will:

  1. Check out the code
  2. Setup pnpm and run pnpm install --frozen-lockfile
  3. Run pnpm build

GitHub will notify users when there is a build error so that the issue may be quickly resolved.