Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 1.98 KB

developing.md

File metadata and controls

74 lines (48 loc) · 1.98 KB
Raw

Developing

Getting Started

Clone the project and cd into it:

git clone [email protected]:forcedotcom/source-deploy-retrieve.git
cd source-deploy-retrieve

Ensure you have Yarn installed, then run:

yarn install
yarn build

Branches

  • Our released (production) branch is main
  • Our work happens in topic branches (feature and/or bug fix)
    • These branches are based on main and can live in forks for external contributors or within this repository for authors
    • Be sure to prefix branches in this repository with <developer-name>/
    • Be sure to keep branches up-to-date using rebase

Testing

Running the test suite

Runs the suite and output code coverage as a text summary:

yarn test

Utilize the Run Tests VS Code debugger configuration to run the test suite with the debugger enabled.

Testing with the command line

Interact with the package exports on the command line by running:

yarn repl

This will start the NodeJS REPL with a few pre-set variables to conveniently interact with exported modules. The REPL runs with the --inspect flag, allowing you to attach a debugger to the process. Select the Attach to Remote configuration in VS Code and click play to debug against it.

Testing in another package

To test the library in another local package, you can link it to such module so any changes that are built will be automatically present without reinstalling:

yarn local:link /path/to/other/project

to unlink the library:

yarn local:unlink /path/to/other/project

Testing with the NPM artifact

The library can also be installed to another local project as a regular NPM module. This is useful for manually testing the package that will be deployed to NPM. Use this instead of the linking process that's described under Development to QA changes before they are published:

yarn local:install /path/to/other/package

Updating the registry

See Metadata.md