How-to guides
How-to guides are goal-oriented recipes for a specific job. New here? Start with the tutorials instead.
Get CI running
- Wire a repository into CI — enable Pipelines and connect a repo for the first run.
- Authenticate CI to an org — wire up the auth URLs a pipeline needs.
Shape a deploy
- Enable delta deployments for a stage — opt a stage into git-diff deploys.
- Control which Apex tests run on a full deploy — curate a test suite or class list for full deploys.
- Replace a value per environment — make a value differ per stage org.
- Add a deployment workaround — patch metadata around a platform limitation.
- Exclude metadata from a deploy or scratch push — pick the right
.forceignorefile per context. - Add a custom pre/post deployment step — weave project logic into a deploy.
Scratch orgs and pooling
- Validate a PR against a scratch org — deploy PRs into a disposable scratch org as a gate.
- Maintain the scratch org pool — seed, top up, and clean pools.
- Write a pool seed script — initialise freshly created pool orgs with your own module.
Org chores
- Refresh your sandbox from a branch — reset a sandbox to match a branch.
- Seed data into an org — load reference/sample records, or escalate to a data tool.
Packaging
- Release a package version — create a version, validate the install, and tag the release.
The toolchain itself
- Baseline the code analyzer — accept existing violations in a brownfield project, then ratchet down.
- Exclude files from lint rules — suppress a rule per file type, or ignore files entirely.
- Add a command to the CLI — extend
dia-scriptswith a new command. - Read a rejected commit — find the verdict in the hook output, in the terminal or VS Code.
- Change a dependency — bump a package through the lockfile, or review someone else's bump.
- Handle a committed secret — from the scanner's finding to a rotated credential and a clean source.