fix: check for commit ref for --to and --from parameters

.github/linters/.cspell.json

@@ -20,6 +20,7 @@
         "appli",
         "authprovider",
         "authproviders",
+        "AUTOUPDATE",
         "behaviour",
         "benchmarkjs",
         "biomejs",

.github/workflows/on-main-push.yml

@@ -70,10 +70,15 @@ jobs:
         with:
           node-version: 18
 
+      - uses: google/wireit@setup-github-actions-caching/v2
+
       - name: Setup dependencies, cache and install
         uses: ./.github/actions/install
 
-      - uses: google/wireit@setup-github-actions-caching/v2
+      - name: Set environment variables
+        run: |
+          echo "SF_DISABLE_AUTOUPDATE=true" >> "$GITHUB_ENV"
+          echo "SF_DISABLE_TELEMETRY=true" >> "$GITHUB_ENV"
 
       - name: Build plugin
         run: npm pack

.github/workflows/reusable-build.yml

@@ -15,11 +15,11 @@ jobs:
         with:
           node-version: 18
 
+      - uses: google/wireit@setup-github-actions-caching/v2
+
       - name: Setup dependencies, cache and install
         uses: ./.github/actions/install
 
-      - uses: google/wireit@setup-github-actions-caching/v2
-
       - name: Lint plugin
         run: npm run lint
 

.github/workflows/run-e2e-tests.yml

@@ -28,6 +28,11 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
 
+      - name: Set environment variables
+        run: |
+          echo "SF_DISABLE_AUTOUPDATE=true" >> "$GITHUB_ENV"
+          echo "SF_DISABLE_TELEMETRY=true" >> "$GITHUB_ENV"
+
       - name: Install cli
         run: npm install -g ${{ matrix.cli }}
 

README.md

@@ -47,6 +47,7 @@
   - [Execute sgd](#execute-sgd)
   - [Deploy the delta metadata](#deploy-the-delta-metadata)
 - [Advanced use-cases](#advanced-use-cases)
+  - [Evaluate uncommitted work as well](#evaluate-uncommitted-work-as-well)
   - [Generate a folder containing only the added/modified sources](#generate-a-folder-containing-only-the-addedmodified-sources)
   - [Exclude some metadata only from destructiveChanges.xml](#exclude-some-metadata-only-from-destructivechangesxml)
   - [Explicitly including specific files for inclusion or destruction regardless of diff](#explicitly-including-specific-files-for-inclusion-or-destruction-regardless-of-diff)
@@ -185,6 +186,13 @@ EXAMPLES
   $ sf sgd source delta --from "origin/development" --output-dir incremental
   - Build incremental manifest and source from the development branch
   $ sf sgd source delta --from "origin/development" --generate-delta --output-dir incremental
+
+FLAG DESCRIPTIONS
+  -a, --api-version=<value>
+
+    salesforce metadata API version, default to sfdx-project.json "sourceApiVersion" attribute or latest version
+
+    Override the api version used for api requests made by this command
 ```
 
 _See code: [src/commands/sgd/source/delta.ts](https://github.com/scolladon/sfdx-git-delta/blob/main/src/commands/sgd/source/delta.ts)_
@@ -352,6 +360,19 @@ sf project deploy start --pre-destructive-changes destructiveChanges/destructive
 
 ## Advanced use-cases
 
+### Evaluate uncommitted work as well
+
+Commit your changes, then use SGD, then reset (soft if you want to keep the changes) the commit
+
+```sh
+git add '<files>'
+git commit -m '<meaningful temporary message>'
+sf sgd source delta --from <sha-pointer>
+git reset --soft HEAD~1
+```
+
+It is also possible to do those operation inside a temporary branch to further isolate the operation.
+
 ### Generate a folder containing only the added/modified sources
 
 Using a package.xml for deployment is the simplest approach to delta deployments. But in some cases you may want to have only the actual recently changed source files.

messages/delta.md

@@ -84,9 +84,13 @@ Attempt to delete the flow '%s' via destructiveChanges.xml may not work as expec
 
 Generating incremental package
 
-# info.CommandHasRun
+# info.CommandSuccess
 
-Done
+Success
+
+# info.CommandFailure
+
+Failure
 
 # info.EncourageSponsorship