sfdx-git-delta 5.1.2 → 5.3.1

package/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [5.3.1](https://github.com/scolladon/sfdx-git-delta/compare/v5.3.0...v5.3.1) (2022-08-04)
+
+## [5.3.0](https://github.com/scolladon/sfdx-git-delta/compare/v5.2.0...v5.3.0) (2022-06-13)
+
+
+### Features
+
+* add batchCalcJobDefinitions metadata ([#312](https://github.com/scolladon/sfdx-git-delta/issues/312)) ([e770955](https://github.com/scolladon/sfdx-git-delta/commit/e770955d70fcc627d7f6488000cf7f45de4c51cb))
+* add restriction rules metadata ([#309](https://github.com/scolladon/sfdx-git-delta/issues/309)) ([24a818d](https://github.com/scolladon/sfdx-git-delta/commit/24a818d954b4ea4506f9b488b0793acfbaa62516))
+* introduce incremental deployment concept ([#306](https://github.com/scolladon/sfdx-git-delta/issues/306)) ([9392add](https://github.com/scolladon/sfdx-git-delta/commit/9392add66cea76d8da9e947d2c077dcdfebe5824))
+
+
+### Bug Fixes
+
+* format issue in the tsconfig ([#307](https://github.com/scolladon/sfdx-git-delta/issues/307)) ([f2ae7d2](https://github.com/scolladon/sfdx-git-delta/commit/f2ae7d2fa7d3b39b7c052d719bcb0b363e32b2b3))
+
+## [5.2.0](https://github.com/scolladon/sfdx-git-delta/compare/v5.1.2...v5.2.0) (2022-04-21)
+
+
+### Features
+
+* add github action linter ([#288](https://github.com/scolladon/sfdx-git-delta/issues/288)) ([9a038db](https://github.com/scolladon/sfdx-git-delta/commit/9a038db6fd7d22ab8b3ff6504018da75022272e6))
+* prepare i18n ([#287](https://github.com/scolladon/sfdx-git-delta/issues/287)) ([001c07e](https://github.com/scolladon/sfdx-git-delta/commit/001c07e736584d34d75dc09005b3d701ddb33639))
+
+
+### Bug Fixes
+
+* fix typo ([#292](https://github.com/scolladon/sfdx-git-delta/issues/292)) ([0f35071](https://github.com/scolladon/sfdx-git-delta/commit/0f35071db77df9c3c6fa0390aaea69000b7e680a))
+* link "Condition deployment" on TOC ([#291](https://github.com/scolladon/sfdx-git-delta/issues/291)) ([051c35a](https://github.com/scolladon/sfdx-git-delta/commit/051c35a927da3426cb51c0044b8497e229d7930a))
+* wave meta file delta generation ([#293](https://github.com/scolladon/sfdx-git-delta/issues/293)) ([ceaff65](https://github.com/scolladon/sfdx-git-delta/commit/ceaff65033a7b77b8e7939f914e0d311533188e7))
+
 ### [5.1.2](https://github.com/scolladon/sfdx-git-delta/compare/v5.1.1...v5.1.2) (2022-04-04)
 
 

package/README.md

@@ -12,7 +12,7 @@
   <h3 align="center">SFDX-Git-Delta </h3>
 
   <p align="center">
-    Generate salesforce deployment content from two git commits!
+    SFDX plugin to generate Incremental Salesforce deployments manifests and artifacts
     <br />
     <a href="https://github.com/scolladon/sfdx-git-delta/issues/new?assignees=scolladon&labels=bug&template=issue.md">Report Bug</a>
     ·
@@ -44,6 +44,7 @@
   - [Explicitly including specific files for inclusion or destruction regardless of diff:](#explicitly-including-specific-files-for-inclusion-or-destruction-regardless-of-diff)
   - [Scoping delta generation to a specific folder](#scoping-delta-generation-to-a-specific-folder)
   - [Generate a comma-separated list of the added and modified Apex classes:](#generate-a-comma-separated-list-of-the-added-and-modified-apex-classes)
+  - [Condition deployment on package.xml and destructiveChange content](#condition-deployment-on-packagexml-and-destructivechange-content)
   - [Use the module in your own node application](#use-the-module-in-your-own-node-application)
 - [Changelog](#changelog)
 - [Built With](#built-with)
@@ -83,7 +84,7 @@ Have a look at this post on the Salesforce Developers Blog to dive into it: [Opt
 
 If you are not a Salesforce Architect or Developer, probably not, _sorry_.
 
-If you are a Technical Architect or Developer, then it’s a very useful tool for you, when meting 3 conditions below:
+If you are a Technical Architect or Developer, then it’s a very useful tool for you, when meeting the 3 conditions below:
 
 1. Your Salesforce project uses a git repo as the source of truth.
 2. You use the Source (DX) format in the repo.
@@ -91,8 +92,8 @@ If you are a Technical Architect or Developer, then it’s a very useful tool fo
 
 SGD is designed to be part of a CI/CD pipeline (Jenkins, Bitbucket Pipelines, GitLab CI, GitHub Actions, Azure DevOps...) that handles the deployment of the sources to the Salesforce org(s).
 
-Pro tip: Make sure your pipeline works **before** implementing delta deployments. Otherwise it will just make it harder to debug your pipeline.
-It's also important to implement a way to switch back to full deployment in case the delta deployment does not behave as expected.
+Pro tip: Make sure your pipeline works **before** implementing incremental deployments. Otherwise it will just make it harder to debug your pipeline.
+It's also important to implement a way to switch back to full deployment in case the incremental deployment does not behave as expected.
 
 **DISCLAIMER:**
 
@@ -150,7 +151,7 @@ OPTIONS
   -W, --ignore-whitespace                                                           ignore git diff whitespace (space,
                                                                                     tab, eol) changes
 
-  -a, --api-version=api-version                                                     [default: 54] salesforce API version
+  -a, --api-version=api-version                                                     [default: 55] salesforce API version
 
   -d, --generate-delta                                                              generate delta files in [--output]
                                                                                     folder
@@ -182,7 +183,7 @@ OPTIONS
                                                                                     this command invocation
 ```
 
-_See code: [src/commands/sgd/source/delta.ts](https://github.com/scolladon/sfdx-git-delta/blob/v5.1.2/src/commands/sgd/source/delta.ts)_
+_See code: [src/commands/sgd/source/delta.ts](https://github.com/scolladon/sfdx-git-delta/blob/v5.3.1/src/commands/sgd/source/delta.ts)_
 <!-- commandsstop -->
 
 ### Windows users
@@ -191,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:
@@ -278,11 +279,7 @@ Note: it is also possible to generate a **source** folder containing added/chang
 
 ### Deploy the delta metadata
 
-The simplest option to deploy the delta changes is to use `force:source:deploy` command with `-x` parameter:
-
-```sh
-sfdx force:source:deploy -x package/package.xml --postdestructivechanges destructiveChanges/destructiveChanges.xml
-```
+The simplest option to deploy the incremental changes is to use `force:source:deploy` command with `-x` parameter:
 
 ```sh
 sfdx force:source:deploy -x package/package.xml --postdestructivechanges destructiveChanges/destructiveChanges.xml
@@ -434,6 +431,22 @@ To cover this need, parse the content of the package.xml file produced by SGD us
 
 `xq . < package/package.xml | jq '.Package.types | [.] | flatten | map(select(.name=="ApexClass")) | .[] | .members | [.] | flatten | map(select(. | index("*") | not)) | unique | join(",")'`
 
+### Condition deployment on package.xml and destructiveChange content
+
+SGD does not always generate content in the package.xml (or destructiveChanges.xml). Sometimes the commit range contains changes only within files to ignore (using .sgdignore and `--i` parameter).
+[Deploying empty package.xml can lead to deployment errors.](https://github.com/scolladon/sfdx-git-delta/issues/249)
+To avoid starting a failing deployment, test files content before execution:
+
+```sh
+# run deploy command only if the generated package contains metadata
+if grep -q '<types>' ./package/package.xml ; then
+  echo "---- Deploying added and modified metadata ----"
+  sfdx force:source:deploy -x package/package.xml
+else
+  echo "---- No changes to deploy ----"
+fi
+```
+
 ### Use the module in your own node application
 
 If you want to embed sgd in your node application, install it has a dependency for your application

package/lib/locales/en.d.ts

@@ -0,0 +1,7 @@
+export const errorGitSHAisBlank: string;
+export const errorParameterIsNotGitSHA: string;
+export const errorAPIVersionIsNan: string;
+export const errorPathIsNotDir: string;
+export const errorPathIsNotFile: string;
+export const errorPathIsNotGit: string;
+export const errorToNotHeadWithDeltaGenerate: string;

package/lib/locales/en.js

@@ -0,0 +1,11 @@
+"use strict";
+module.exports = {
+    errorGitSHAisBlank: '--%s is blank: "%s"',
+    errorParameterIsNotGitSHA: '--%s is not a valid sha pointer: "%s"',
+    errorAPIVersionIsNan: 'api-version %s is not a number',
+    errorPathIsNotDir: '%s folder does not exist',
+    errorPathIsNotFile: '%s file does not exist',
+    errorPathIsNotGit: '%s is not a git repository',
+    errorToNotHeadWithDeltaGenerate: '--generate-delta (-d) parameter cannot be used when --to (-t) parameter is not equivalent to HEAD',
+};
+//# sourceMappingURL=en.js.map

package/lib/locales/en.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"en.js","sourceRoot":"","sources":["../../src/locales/en.js"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,GAAG;IACf,kBAAkB,EAAE,qBAAqB;IACzC,yBAAyB,EAAE,uCAAuC;IAClE,oBAAoB,EAAE,gCAAgC;IACtD,iBAAiB,EAAE,0BAA0B;IAC7C,kBAAkB,EAAE,wBAAwB;IAC5C,iBAAiB,EAAE,4BAA4B;IAC/C,+BAA+B,EAC7B,mGAAmG;CACtG,CAAA"}

package/lib/metadata/v51.json

@@ -1,4 +1,11 @@
 [
+    {
+        "directoryName": "batchCalcJobDefinitions",
+        "inFolder": false,
+        "metaFile": false,
+        "suffix": "batchCalcJobDefinition",
+        "xmlName": "BatchCalcJobDefinition"
+    },
     {
         "directoryName": "installedPackages",
         "inFolder": false,

package/lib/metadata/v52.json

@@ -1,4 +1,11 @@
 [
+    {
+        "directoryName": "batchCalcJobDefinitions",
+        "inFolder": false,
+        "metaFile": false,
+        "suffix": "batchCalcJobDefinition",
+        "xmlName": "BatchCalcJobDefinition"
+    },
     {
         "directoryName": "installedPackages",
         "inFolder": false,
@@ -1119,6 +1126,13 @@
         "suffix": "deployment",
         "xmlName": "RecordActionDeployment"
     },
+    {
+        "directoryName": "restrictionRules",
+        "inFolder": false,
+        "metaFile": false,
+        "suffix": "rule",
+        "xmlName": "RestrictionRule"
+    },
     {
         "directoryName": "EmbeddedServiceConfig",
         "inFolder": false,

package/lib/metadata/v53.json

@@ -1,4 +1,11 @@
 [
+    {
+        "directoryName": "batchCalcJobDefinitions",
+        "inFolder": false,
+        "metaFile": false,
+        "suffix": "batchCalcJobDefinition",
+        "xmlName": "BatchCalcJobDefinition"
+    },
     {
         "directoryName": "installedPackages",
         "inFolder": false,
@@ -1119,6 +1126,13 @@
         "suffix": "deployment",
         "xmlName": "RecordActionDeployment"
     },
+    {
+        "directoryName": "restrictionRules",
+        "inFolder": false,
+        "metaFile": false,
+        "suffix": "rule",
+        "xmlName": "RestrictionRule"
+    },
     {
         "directoryName": "EmbeddedServiceConfig",
         "inFolder": false,

package/lib/metadata/v54.json

@@ -1,4 +1,11 @@
 [
+    {
+        "directoryName": "batchCalcJobDefinitions",
+        "inFolder": false,
+        "metaFile": false,
+        "suffix": "batchCalcJobDefinition",
+        "xmlName": "BatchCalcJobDefinition"
+    },
     {
         "directoryName": "installedPackages",
         "inFolder": false,
@@ -1119,6 +1126,13 @@
         "suffix": "deployment",
         "xmlName": "RecordActionDeployment"
     },
+    {
+        "directoryName": "restrictionRules",
+        "inFolder": false,
+        "metaFile": false,
+        "suffix": "rule",
+        "xmlName": "RestrictionRule"
+    },
     {
         "directoryName": "EmbeddedServiceConfig",
         "inFolder": false,