Getting started

1. Install the GitHub App

Install Sunset from the GitHub Marketplace on your organization, or on individual repos if you'd rather scope it down to start. Sunset requests read access to repo contents and pull request write access; nothing more.

2. Connect your repos

Once installed, pick which repos to connect. For an agency, connecting the whole org is the point, that's what makes the Portfolio Drift Board useful. You can start with a handful and add the rest once you've seen how it behaves.

3. First scan

Sunset runs an initial scan on every connected repo: an AST pass to find Shopify Admin API call sites, the version each one resolves to, and whether that call is direct or routed through your own wrapper code. This can take a few minutes on a large repo. You'll get a summary when it's done.

4. Read the Drift Board

The board shows every connected repo, what it's calling, which calls touch a field or endpoint on Shopify's deprecation schedule, and the sunset date attached to each one. Nothing here has changed your code yet; this is the advisory layer, available on every tier including the free one.

5. Your first draft PR

If you're on the Fix or Portfolio tier, Sunset will start opening draft PRs for real matches, each with a report: what's breaking, the changelog citation it worked from, every call site touched, and the test result from running your suite against the new API version. Review it the way you'd review any PR. Nothing merges on its own.

6. Set up alerts

On Portfolio, connect Slack to get pinged when a new high-severity drift shows up, rather than checking the board manually. Severity is based on how close the sunset date is and how many call sites are affected.