Overview

With the GitHub integration connected, the Deployments module runs itself: your pipeline's deployment events create and update Scrambl deployments, Scrambl works out which tasks shipped by reading the code range, and tasks move to the right status when the release lands. This article walks through the setup and how each link in the chain works.

Who can do this

  • Required access: an access level that includes Projects - Standard Access or Projects - Full Access.
  • Default access levels that include it: Team Member, Accountant, and System Administrator.
  • Owners and admins: always allowed. Workspace owners and admins are not limited by access levels.
  • You also need access to the project the deployments belong to.
  • Personal accounts: The Family Admin, Family Member, and Limited Member presets include this access. The space owner and admins can always do it.

Owners and admins review and change access levels in Settings → Administration → Members → Access levels.

Before you start

  • Connect the GitHub integration for your workspace and link the repository to your project.
  • Enable the Deployments toggle in the project's settings.
  • In the project's environments, set the git branch each environment tracks (for example, production tracking main).

Detection works through the link between tasks and pull requests. Create that link from the task itself:

  1. Open a task and find its GitHub section, which lists branches and pull requests for the task.
  2. Use Create branch to start a branch named after the task number, or connect an existing pull request.
  3. Ship the work through your normal PR flow. When the PR merges, the link records the merge.

Step 2: Let deployment events flow in

When your pipeline reports a deployment to GitHub, Scrambl receives it automatically:

  • A starting deployment marks the matching Scrambl deployment as Deploying — or creates one automatically when the repository, environment, and project line up.
  • Success marks it Deployed; a failed rollout marks it Failed.

Step 3: Automatic scope detection

When a deployment reaches Deployed (or when you click Detect on its detail panel), Scrambl compares the commit range between this deploy and the last successful deploy to the same environment. It reads the merged pull requests out of that range and matches them against your task links; every matched task is added to the deployment's scope as a detected item. Commits that match nothing are listed so you can see what shipped untracked.

Step 4: Automatic status transitions

  1. Open the project's settings and find the deployment automation options.
  2. For each environment, choose the status tasks should move to when a deployment there completes — or Do nothing.
  3. From then on, when a release lands, every task in its scope moves through the normal status path, with the usual notifications.

You can also configure status moves for when a pull request opens or merges, per repository, so tasks track code review progress before anything deploys.

Good to know: The very first deploy to an environment has no baseline to compare against, so detection starts working from the second deploy — or set the from commit manually on the first one.


Troubleshooting

IssueWhat to check
Deployments are not appearing automatically.Confirm the repository is linked to the project, Deployments is enabled, and the environment name in your pipeline matches an environment here.
Detection finds no tasks.Tasks must be linked to their pull requests — create branches and PRs from the task's GitHub section.
Statuses did not move on deploy.Check the per-environment automation setting; environments set to Do nothing are skipped.

Next steps

  • Turn the detected scope into stakeholder notes — see the release notes article.
  • Review the module basics in the deployments overview.