Skip to content

SvataSejkora/default-scratch-org-template

Repository files navigation

DX Project Template

1.Update the following properties for your new project:

  • orgName in config/project-scratch-def.json file.
  • name and description values in package.json file.
  • Note that the standard Admin profile is in .forceignore. You may need to change this in rare cases e.g. AppExchange app.
  1. Optional: update the sourceApiVersion in sfdx-project.json.

  2. Update README.md of your new DX project.

Dev Tools

  • SFDX Data Move Utility - powerful data migration tool.

    • After installation, see example configuration in data/export.json.
    • The idea for DX projects is to keep data/export.json configuration present in its repository so that everyone can import sample data into his scratch org easily.
    • Import can be run at any time, nevertheless, it is usually part of scratch org init task.
    • Import data from data/<sobject>.csv files using preconfigured npm script:
      $ npm run data:import --target=orgAlias
    • To export new data, you may need to update the configuration, see plugin's documentation.
    • Export data to csv files using preconfigured npm script:
      $ npm run data:export --source=orgAlias
    • Before committing a new configuration or data, ensure that import works just fine to prevent others having issues.
  • SFDX-Git-Delta - prepare package.xml within seconds.

    • Handy tool for not only deployment-responsible people.
    • Git is a prerequisite. No remote repository is needed though.
    $ sfdx sgd:source:delta --to "HEAD" --from "HEAD^" --output .
    $ sfdx force:source:deploy -x package/package.xml -u targetOrg
    $ sfdx force:mdapi:deploy -d destructiveChanges --ignorewarnings -u targetOrg
  • CI-SFDX-Plugin - set of commands making CI and dev's life easier when using scratch orgs.

    • Install the plugin, update configuration in ciconfig.json and npm scripts in package.json for your new project following steps on the plugin's homepage.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published