Scratch Org Definition

Die JSON-Datei, die festlegt, mit welcher Edition, welchen Features und Einstellungen eine neue Scratch Org erstellt werden soll.

Definition

Eine Scratch Org Definition ist die JSON-Datei, üblicherweise config/project-scratch-def.json, die an sf org create scratch --definition-file übergeben wird und explizit festlegt, wie eine neue Scratch Org aussehen soll: Edition (Developer, Enterprise), aktivierte Features (Communities, Multicurrency), Org-Einstellungen und Konfigurationen, die sonst manuelle Klicks in Setup erfordern würden. Sie ist eine explizite, versionskontrollierte Alternative zu Org Shape, das stattdessen Konfiguration automatisch aus einer bestehenden Sandbox erfasst. Teams committen ihre Definitionsdatei ins Repo, sodass jede Scratch Org jedes Entwicklers, und jede von CI erstellte, von derselben bekannten Konfiguration startet, was wichtig ist, weil eine Scratch Org, der ein von der Codebase benötigtes Feature fehlt, Deployments oder Tests auf verwirrende Weise scheitern lässt. Die Definitionsdatei falsch zu bekommen, ist eines der häufigeren frühen Scratch-Org-Kopfschmerzen. Unser Guide zu Salesforce-DevOps-Plattformen behandelt Stolpersteine beim Einrichten von Scratch Orgs ausführlicher.

In der Praxis

So funktioniert es in Serpent

Serpent wendet die Scratch Org Definition eines Teams automatisch an, jedes Mal wenn es als Teil der Task-Einrichtung eine Scratch Org bereitstellt, sodass jeder Entwickler eine identisch konfigurierte Umgebung erhält, ohne manuell CLI-Flags auszuführen. Org-Einstellungen, Features und Seed-Daten werden konsistent auf die gepoolten Scratch Orgs angewendet, die Serpent für das Team warmhält. Siehe Org-Management bei Serpent dafür, wie sich die Bereitstellung von Scratch Orgs neben Sandboxes einfügt.

Serpent-Formular Scratch Orgs Definition zum Festlegen von Org-Name, Edition, Features und Sprache an einem Ort

Häufige Fragen