Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.slipway.sh/llms.txt

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

A repository is a GitHub repo that’s been ingested through an installation. Every repo in the installation appears under Repos in the org; you decide which ones slipway should actually deploy.

​
Enable / disable

Each repo has a single switch — slipway_enabled. When you click Enable:
  1. slipway fetches slipway.yaml from the default branch.
  2. The spec is parsed and validated. If it’s missing or invalid, enable fails with the precise error — no infrastructure is touched.
  3. The repo is marked enabled.
From that point, pushes to the default branch and PRs are picked up by the webhook handler and trigger deployments. Disabling a repo stops new deployments but doesn’t tear down healthy ones. Tear them down explicitly if you don’t want them lingering.

​
PR comments

Each repo has a comment_on_prs flag (default on). When on, slipway posts a single comment in the PR thread that mirrors the most recent deployment’s state:
  • 🔁 Rebuilding — a new commit landed; slipway is building. The previous preview URL stays in the comment until the new build cuts over.
  • ✅ Live — the new preview is healthy. Shows the URL and the commit SHA.
  • ❌ Failed — the build or deploy failed. Shows the reason.
  • 🗑 Torn down — the PR was closed.
The comment is edited in place across commits — you won’t get a wall of new comments on a long PR. Disable from the repo detail page if your reviewers prefer a quieter PR thread.

​
Default-branch only

Manual deploys and pushes are scoped to the default branch. PR previews work for any branch that opens a PR against the default branch (or any branch GitHub fires pull_request events for). This is intentional — feature-branch previews without a PR are easy to forget about, and slipway is designed around the PR review flow.

​
What happens to repos you don’t enable

slipway lists every repo the installation has access to, but none of them deploy until you flip the switch. Repos you didn’t grant access to during install are entirely invisible to slipway.

​
Resyncing repos

If you grant the installation access to new repos in GitHub after the fact, slipway picks them up from the installation_repositories webhook. If you want to force a manual resync (e.g. after a permission change), use Settings → Integrations → Sync repos.