Skip to main content

Documentation Index

Fetch the complete documentation index at: https://handbook.polar.sh/llms.txt

Use this file to discover all available pages before exploring further.

The @polar-sh/checkout package lives in clients/packages/checkout/ inside the main polarsource/polar monorepo and is published to npm via Changesets.

​
Prerequisites

  • Access to the polarsource/polar repository
  • pnpm installed (check the version in clients/package.json)
  • Your changes to clients/packages/checkout/ are ready on a branch

​
Steps

1
Create a changeset
2
From the clients/ directory, run:
3
pnpm changeset
4
The CLI will prompt you to:
5
  • Select the package — choose @polar-sh/checkout
  • Choose the bump type — patch for bug fixes, minor for new features, major for breaking changes
  • Write a summary — describe the change in one sentence (this ends up in the CHANGELOG)
    • 6
    This creates a new Markdown file under clients/.changeset/. Commit it together with your code changes.
    7
    Open a PR to main
    8
    Push your branch and open a pull request as normal. The changeset file must be included in the PR.
    9
    Merge to main
    10
    Once the PR is reviewed and merged, the Changesets GitHub Action runs automatically. It opens (or updates) a “Version Packages” PR that:
    11
  • Bumps the version in package.json
  • Updates CHANGELOG.md
  • Removes the consumed changeset file(s)
    • 12
    Merge the “Version Packages” PR
    13
    Review and merge the “Version Packages” PR. On merge, the action runs the publish pipeline:
    14
    turbo run build lint test --filter='./packages/*' && changeset publish
    15
    This builds, lints, and tests all packages, then publishes @polar-sh/checkout to npm with provenance.

    ​
    Notes

    • The changeset config lives at clients/.changeset/config.json. The default access is restricted, but @polar-sh/checkout overrides this via publishConfig.access: "public" in its own package.json — so it publishes publicly to npm.
    • You do not need to manually run npm publish or bump the version yourself.
    • If multiple changesets accumulate before the “Version Packages” PR is merged, they are all batched into a single release.