sfdx-project.json fields simply-cicd reads

Beyond the dependencies every install-packaged/install-dependencies command installs (packageDirectories[].dependencies, standard sfdx-project.json), a handful of build * commands read a few extra fields. The package-directory-level ones all belong on the default package directory — the entry with "default": true.

{
  "packageDirectories": [
    {
      "path": "force-app",
      "default": true,
      "package": "MyPackage",
      "versionNumber": "1.0.0.NEXT",
      "definitionFile": "config/project-scratch-def.json",
      "seedMetadata": {
        "path": "seed-data"
      },
      "packageMetadataAccess": {
        "permissionSets": ["My_Permission_Set"],
        "permissionSetLicenses": ["MyPackage_License"]
      }
    }
  ],
  "plugins": {
    "simply": {
      "coverageRequirement": {
        "minimumCoverageRequired": "80"
      },
      "utam": {
        "packageName": "@acme/my-package-pageobjects",
        "alias": { "salesforce-pageobjects/*": "salesforce-pageobjects/*" },
        "peerDependencies": { "salesforce-pageobjects": "^12.0.0" },
        "compilerConfig": "config/utam.config.json"
      }
    }
  }
}

• definitionFile — the scratch org definition file build create-scratch creates the org from. Falls back to --scratch-definition-file if omitted here; required (along with package) for build create-package-version to know what to version.
• packageMetadataAccess.permissionSets / packageMetadataAccess.permissionSetLicenses — assigned to the scratch org’s default user right after creation, by build create-scratch. Both are optional and independent — set either, both, or neither.
• seedMetadata.path — an extra source directory build push-scratch deploys alongside the default package directory. Only pushed when the stage is also given --scratch-org-source-dir; the field by itself doesn’t trigger anything (see Scratch org build lifecycle).
• plugins.simply.coverageRequirement.minimumCoverageRequired — overrides create-package-version’s --code-coverage-minimum default of 75. A string, not a number, matching the rest of sfdx-project.json’s convention for numeric-looking values nested under plugins.
• plugins.simply.utam — configuration for build publish-utam-page-objects, which compiles the project’s UTAM page objects for each package version and publishes them to npm. All four keys are optional, but packageName has to be set here or passed as --npm-package-name:
  • packageName — the npm package to publish under. --npm-package-name wins when both are given.
  • alias — UTAM compiler type aliases, passed straight through to the generated compiler config. Rewrites the import specifier a "type" reference compiles to.
  • peerDependencies — merged into the published package’s peers, alongside the @utam/core peer it always declares. For projects whose page objects reference salesforce-pageobjects or another package’s page objects.
  • compilerConfig — path to a compiler config whose keys the command doesn’t own (profiles, lint, interruptCompilerOnError, …). Merged underneath the ones it does: the package directory, the file masks, the output directories, module, version, and copyright.

None of these fields are required to use simply-cicd — every command falls back to a CLI flag or a hardcoded default when they’re absent. They exist so a value that’s really a property of the project (which permission sets a scratch org needs, what coverage bar the package must clear) can live in source control next to the project it describes, instead of being repeated across pipeline YAML.