# Salesforce DevOps Starter Kit

> CI/CD building blocks for Salesforce

Compose flexible, GitHub-native pipelines from small, focused Actions - or drop in a ready-made reusable workflow and be productive in minutes.

## Table of Contents

### Guide

- [Getting Started](https://svierk.github.io/salesforce-devops-starter-kit/getting-started.md): Set up a first Salesforce CI/CD pipeline with the kit - from choosing a strategy and configuring JWT authentication to pull request validation and deployment.
- [Authentication](https://svierk.github.io/salesforce-devops-starter-kit/authentication.md): Authenticate CI/CD pipelines to Salesforce orgs with the JWT bearer flow or an SFDX Auth URL, and store the credentials as GitHub Actions secrets.

### Strategy & Blueprints

- [Find your blueprint](https://svierk.github.io/salesforce-devops-starter-kit/strategy.md): Five questions about orgs, teams, team setup, maturity and release style route a Salesforce team to one of five DevOps blueprints.
- [B1 - Simple Org Development](https://svierk.github.io/salesforce-devops-starter-kit/strategy/b1-simple-org-development.md): One team on one production org - GitHub Flow with short-lived feature branches, PR validation and a gated production deployment.
- [B2 - Multi-Team with Environment Branches](https://svierk.github.io/salesforce-devops-starter-kit/strategy/b2-multi-team-environment-branches.md): Several teams sharing one production org - environment branches with story promotion, release bundles or a release train, and approval gates per stage.
- [B3 - Modular Trunk](https://svierk.github.io/salesforce-devops-starter-kit/strategy/b3-modular-trunk.md): Several mature teams on one trunk - feature flags, source modules or unlocked packages, and a validation gate plus scratch org CI that genuinely block.
- [B4 - Multi-Org / Regional Rollout](https://svierk.github.io/salesforce-devops-starter-kit/strategy/b4-multi-org-regional.md): Several production orgs by region or business unit - a shared core as pinned package versions, or one environment chain per org.
- [B5 - Low-Code First](https://svierk.github.io/salesforce-devops-starter-kit/strategy/b5-low-code-admin-first.md): Admin-heavy teams where Git knowledge is the bottleneck - two org-bound branches, tool-driven promotion and a validation gate tuned to declarative work.
- [Kit Mapping](https://svierk.github.io/salesforce-devops-starter-kit/strategy/mapping.md): Which reusable workflows, input settings, branch protection rules and GitHub Environments each of the five blueprints switches on.
- [Background & Trade-Offs](https://svierk.github.io/salesforce-devops-starter-kit/strategy/background.md): The reasoning behind the blueprints - sandbox types and licences, single- vs. multi-org, org vs. package development, branching models, release styles and maturity levels.

### Reusable Workflows

- [PR Validation](https://svierk.github.io/salesforce-devops-starter-kit/workflows/pr-validation.md): Reusable workflow that validates a pull request without changing the target org.
- [Create Scratch Org](https://svierk.github.io/salesforce-devops-starter-kit/workflows/create-scratch-org.md): Reusable workflow that provisions a ready-to-use scratch org as a self-service task.
- [Scratch Org CI](https://svierk.github.io/salesforce-devops-starter-kit/workflows/scratch-org-ci.md): Reusable workflow that runs a full scratch org lifecycle.
- [Deployment](https://svierk.github.io/salesforce-devops-starter-kit/workflows/deployment.md): Reusable workflow that deploys Salesforce metadata to a target org (sandbox or production).
- [Promote](https://svierk.github.io/salesforce-devops-starter-kit/workflows/promote.md): Reusable workflow that prepares a promotion between long-lived branches as a pull request.

### Building Blocks · Setup & Auth

- [🕵🏻 Get Node Version](https://svierk.github.io/salesforce-devops-starter-kit/blocks/get-node-version.md): Resolve and set up the Node.js version from package.json.
- [⚙️ SFDX CLI Setup](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-cli-setup.md): Install the Salesforce CLI and related plugins.
- [🔐 SFDX Login](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-login.md): Authenticate to any org via SFDX Auth URL or the JWT flow.

### Building Blocks · Scratch Orgs

- [🌩️ SFDX Create Scratch Org](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-create-scratch-org.md): Create a scratch org and output its username and org ID.
- [🗑️ SFDX Delete Scratch Org](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-delete-scratch-org.md): Delete a scratch org to clean up after a pipeline run.

### Building Blocks · Deploy & Test

- [🚀 SFDX Deploy](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-deploy.md): Deploy metadata, with delta and validation-only (dry-run) modes.
- [✅ SFDX Run Tests](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-run-tests.md): Run Apex, LWC (Jest) and Flow tests with coverage reporting.

### Building Blocks · Quality & Data

- [🔎 SFDX Code Review](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-code-review.md): Static quality gate: Code Analyzer, Prettier and ESLint.
- [📦 SFDX Package Installation](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-package-installation.md): Install managed or unlocked packages on a target org.
- [💾 SFDX Data Import](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-data-import.md): Import records via Bulk API 2.0 (CSV) or sObject Tree (JSON).

### Building Blocks · Post-Deploy

- [🛡️ SFDX Assign Permissions](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-assign-permissions.md): Assign permission sets, groups and licenses to org users.
- [📜 SFDX Apex Execute](https://svierk.github.io/salesforce-devops-starter-kit/blocks/sfdx-apex-execute.md): Run anonymous Apex for post-deploy scripts and data migrations.