NoShip/Docs
Dashboard

Getting Started

Get up and running with NoShip in under five minutes. Install the GitHub App, configure your repositories, and create your first freeze window.

1. Install the GitHub App

NoShip works as a GitHub App installed on your organization. It uses commit status checks and deployment protection rules to enforce freezes -- it never reads or accesses your source code.

To install:

  1. Click Install GitHub App on the NoShip landing page, or navigate to the NoShip listing on the GitHub Marketplace.
  2. Select the GitHub organization you want to manage.
  3. Choose which repositories NoShip should monitor. You can select all repositories or pick specific ones.
  4. Approve the requested permissions. NoShip requires:
    • Commit statuses -- to set pass/fail checks on pull requests
    • Deployment environments -- to act as a deployment protection rule
    • Organization members (read) -- to sync your team for access control
    NoShip does not request read access to code, pull request contents, or repository files.

2. Configure Branch Protection

After installation, you need to tell GitHub to enforce the NoShip status check. Without this step, freezes will show a status on PRs but will not block merging.

Option A: Repository Rulesets (recommended)

Repository rulesets are the modern way to enforce branch rules in GitHub.

  1. Go to your repository's Settings → Rules → Rulesets.
  2. Create a new ruleset (or edit an existing one) targeting your default branch.
  3. Under Require status checks to pass, add NoShip as a required check.
  4. Save the ruleset.

Option B: Branch Protection Rules (classic)

  1. Go to Settings → Branches in your repository.
  2. Edit (or create) the branch protection rule for your default branch.
  3. Enable Require status checks to pass before merging.
  4. Search for and add NoShip in the status checks list.
  5. Save the rule.

Deployment Protection Rules

To block deployments (not just merges), add NoShip as a deployment protection rule on your GitHub environments:

  1. Go to Settings → Environments in your repository.
  2. Select the environment (e.g. production).
  3. Under Deployment protection rules, enable the NoShip rule.

The NoShip dashboard also provides a Protection Status view that shows which repos and environments have NoShip properly configured.

3. Create Your First Freeze

Once the GitHub App is installed and branch protection is configured, create a freeze window from the dashboard.

Quick Freeze

A quick freeze takes effect immediately and blocks all repos until you cancel it. This is useful for emergency lockdowns.

  1. Open the NoShip dashboard.
  2. Click Create Freeze.
  3. Toggle Quick Freeze on.
  4. Give it a name (e.g. “Release v2.0 lockdown”).
  5. Optionally add rules to scope the freeze to specific repos, branches, or environments.
  6. Click Create. The freeze is now active.

Scheduled Freeze Window

A scheduled freeze has a defined start and end time. Useful for planned releases, maintenance windows, or holiday freezes.

  1. Click Create Freeze.
  2. Set the Start and End date and time.
  3. Add freeze rules if needed.
  4. Click Create. The freeze will automatically activate and deactivate at the specified times.

Connect Slack to manage freezes with natural language, get notifications, and interact with the NoShip AI assistant.

  1. Go to Dashboard → Settings.
  2. In the Slack section, click Connect Slack.
  3. Authorize the NoShip Slack app for your workspace.
  4. Once connected, you can DM the NoShip bot or mention it in any channel to manage freezes, check status, and request overrides.

You are now set up. Explore Core Concepts to understand freeze rules, schedules, and overrides in depth.