Skip to content

Commit

Permalink
docs: improve README (#318)
Browse files Browse the repository at this point in the history
  • Loading branch information
mcherfaouiSFDC authored and scolladon committed Jul 12, 2022
1 parent d97df7b commit a231b86
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,8 @@ If you run SGD on a Windows system, use double quotes [to prevent the terminal t

### CI/CD specificity

In CI/CD pipelines, branches are not checked out locally when the repository is cloned so you must specify the remote prefix.
If you do not specify the remote in CI context, the git pointer check will raise an error as the branch is not created locally.
In CI/CD pipelines, branches are not checked out locally when the repository is cloned, so you must specify the remote prefix.
If you do not specify the remote in CI context, the git pointer check will raise an error (as the branch is not created locally).
This applies to both `--from` and `--to` parameters as they both accept git pointers.

Exemple comparing `HEAD` with a `development` branch when the CI clone the repository with `origin` set as reference to the remote:
Expand Down Expand Up @@ -285,10 +285,6 @@ The simplest option to deploy the incremental changes is to use `force:source:de
sfdx force:source:deploy -x package/package.xml --postdestructivechanges destructiveChanges/destructiveChanges.xml
```

```sh
sfdx force:source:deploy -x package/package.xml --postdestructivechanges destructiveChanges/destructiveChanges.xml
```

And voilà! 🥳

However, keep in mind thate the above command will fail if the destructive change was supposed to be executed before the deployment (i.e. as `--predestructivechanges`), or if a warning occurs during deployment. Make sure to protect your CI/CD pipeline from those scenarios, so that it don't get stuck by a failed destructive change.
Expand Down

0 comments on commit a231b86

Please sign in to comment.