Skip to content

Manual (AIK)

This template uses a manual release script and ships with Astro Integration Kit. Copy it locally by running the following command:

Terminal window
pnpm dlx giget@latest gh:florian-lefebvre/astro-integration-template/templates/manual-kit my-integration

Prerequisites

Make sure you have the GitHub CLI installed, and you’re logged in (gh auth login)

Setup

  1. Search for TODO: and update them

  2. Update all occurences of package-name with your package name

  3. Add a LICENSE at the root (if you do it through GitHub interface, you’ll be able to see all licenses and pick the best one for your project)

  4. Pick the right NPM tags, see official docs

  5. Setup your GitHub repository

Good practises

  • Start working on your integration logic
  • Write some docs, either in the README or as a standalone docs website (not included in the template)
  • Write good JSDoc annotations
  • Format and lint with pnpm lint:fix

Releasing

  1. Add a changeset and add a meaningful message:

    Terminal window
    pnpm changeset

    You can write several changesets if applicable.

  2. Commit and push

    Terminal window
    git add .
    git commit -m "chore: changeset"
    git push
  3. Release (accepts a --otp flag)

    Terminal window
    pnpm release