busbar-actions/Busbar — sf-snapshot
Create a Salesforce scratch-org snapshot (OrgSnapshot) via direct API. Auths the DevHub via busbar-auth.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| target-instance | PRIMARY OIDC path: instance URL of the Busbar-equipped DevHub to mint a short-lived token against (e.g. busbar-pilot-demo2). Passed to the binary as SF_INSTANCE_URL; with `id-token: write` granted, busbar-auth OIDC-exchanges in-process (no SF_ACCESS_TOKEN handoff). | no | "" |
| name | Snapshot name (unique within the DevHub). | yes | — |
| source-org | 15- or 18-char id of the source scratch org (the `ScratchOrg` field from sf-org-create output). | yes | — |
| description | Optional description. | no | "" |
| content | Optional content selector (usually `metadatadata`). | no | "" |
| poll-timeout-secs | Seconds to wait for the snapshot to reach Active (can take 30+ min for large orgs). | no | 3600 |
| result-output | Path to write the snapshot result JSON. | no | .busbar/snapshot-result.json |
| version | Release tag of the sf-snapshot binary. Falls back to env.BUSBAR_ACTION_VERSION, then "latest". | no | "" |
| binary-repo | GitHub repo hosting prebuilt binary releases. Falls back to env.BUSBAR_ACTION_REPO, then busbar-actions/actions-dist. | no | "" |
Outputs
| name | description |
|---|---|
| snapshot-id | OrgSnapshot record id (pass to sf-org-delete --snapshot-id when retiring). |
| status | Final status (Active on success). |
| snapshot-name | Canonical snapshot name. |
| rotated | "true" when zero-downtime rotation was used. |
| expiration-date | Snapshot expiration date when provided by Salesforce. |
| result-path | Path to the JSON file containing the snapshot result. |