synatic/Synatic Entity Sync

Generate entity sync plans from a Synatic org and commit them to Git, or execute a committed plan against a destination org.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
commandAction command: plan or executeyes
api-urlSynatic API base URL (no trailing slash)yes
api-keySynatic org API key (syn_api_...). Store as a secret.yes
source-org-idSource organization MongoDB ObjectId for plan command (URL segment)
root-typeRoot entity type for plan command (flow, solution, parameter, etc.). Use with root-id, or use roots instead.
root-idRoot entity MongoDB ObjectId for plan command
rootsJSON array of { rootType, rootId } objects for plan command. Alternative to root-type + root-id.
plan-pathPath to the plan JSON file in the repositoryno.synatic/plans/plan.json
plan-optionsJSON string of plan options passed to the APIno{}
github-tokenGitHub token for auto-commit and pull requests (defaults to the workflow token)no${{ github.token }}
auto-commitFor plan command: commit plan file to Git (default true)notrue
create-prFor plan command with auto-commit: open a pull request (default true)notrue
pr-titlePull request title when create-pr is trueno
pr-bodyPull request body when create-pr is trueno
pr-base-branchBase branch for pull request or commitnomain
commit-messageCommit message when auto-commit is truenochore: update entity sync plan
dest-org-idDestination organization MongoDB ObjectId for execute command (URL segment)
preview-firstFor execute command: run preview before execute (default true)notrue
preview-onlyFor execute command: stop after preview without executingnofalse
fail-on-conflictFor execute command: fail when preview reports conflicts (default true)notrue
namedescription
plan-idPlan UUID from generated or executed plan
plan-pathPath to the plan file written or read
branch-nameBranch name created when auto-commit is enabled
run-idExecute run id when execute command completes
summaryJSON string of preview or execute summary
conflictsConflict count from preview