6street-cli

Install

sf plugins install @6street/[email protected]

Issues

Please report any issues at https://github.com/6street/6street-cli/issues

Contributing

1. Please read Salesforce's Code of Conduct
2. Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
3. Fork this repository.
4. Build the plugin locally
5. Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
6. Edit the code in your fork.
7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
8. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

Build

To build the plugin locally, make sure to have yarn installed and run the following commands:

# Clone the repository
git clone [email protected]:6street/6street-cli

# Install the dependencies and compile
yarn && yarn build

To use your plugin, run using the local ./bin/dev or ./bin/dev.cmd file.

# Run using local run file.
./bin/dev release generate manifest

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins

Commands

• sf release generate manifest
• sf release validate manifest

sf release generate manifest

Generates a package.xml manifest based on git changes made in a branch.

USAGE
  $ sf release generate manifest [--json] [-f] [-d <value>] [-s <value>]

FLAGS
  -d, --output-dir=<value>  [default: ./manifest] Selected output folder for the manifest file.
  -f, --force               Overwrites an existing package.xml in the output folder if it exists.
  -s, --source=<value>      Branch or commit we're comparing to for the diff. If this flag is omitted, this command will
                            attempt to look through the git log and guess where this branch originated from - this may
                            be unreliable.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Generates a package.xml manifest based on git changes made in a branch.

  Uses the Salesforce Git Delta package to help generate a package.xml manifest based on git changes made in a branch.

EXAMPLES
  $ sf release generate manifest

sf release validate manifest

Validates a package.xml manifest against a target org

USAGE
  $ sf release validate manifest -o <value> [--json] [-f] [-d <value>] [-l
    NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg] [-t <value>]

FLAGS
  -d, --output-dir=<value>   [default: ./manifest] Selected output folder for the manifest file.
  -f, --force                Overwrites an existing package.xml in the output folder if it exists.
  -l, --test-level=<option>  [default: NoTestRun] Which test level of Salesforce deployment to run
                             <options: NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg>
  -o, --target-org=<value>   (required) Selected target org to perform the validation against
  -t, --tests=<value>...     Which specific test classes to run along with deployment when using RunSpecifiedTests

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Validates a package.xml manifest against a target org

  Performs a dry-run against a target org for the current branch using a standard location for package.xml, generating
  the package using `release generate manifest` if it does not exist yet.

EXAMPLES
  $ sf release validate manifest