@jayree/sfdx-plugin-manifest 3.6.23 → 3.6.25

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [3.6.25](https://github.com/jayree/sfdx-plugin-manifest/compare/3.6.24...3.6.25) (2025-01-05)
+
+
+### Bug Fixes
+
+* **deps:** bump @salesforce/source-tracking from 7.3.4 to 7.3.5 ([#1608](https://github.com/jayree/sfdx-plugin-manifest/issues/1608)) ([f09379d](https://github.com/jayree/sfdx-plugin-manifest/commit/f09379d989899ab75a6e9ba95006386981105ab1))
+
+
+
+## [3.6.24](https://github.com/jayree/sfdx-plugin-manifest/compare/3.6.23...3.6.24) (2024-12-29)
+
+
+### Bug Fixes
+
+* **deps:** bump @salesforce/source-deploy-retrieve ([#1606](https://github.com/jayree/sfdx-plugin-manifest/issues/1606)) ([60e0a66](https://github.com/jayree/sfdx-plugin-manifest/commit/60e0a665550b24356242c2456f7b651e9f0fcad6))
+
+
+
 ## [3.6.23](https://github.com/jayree/sfdx-plugin-manifest/compare/3.6.22...3.6.23) (2024-12-21)
 
 

package/README.md

@@ -7,24 +7,76 @@ A Salesforce CLI plugin containing commands for creating manifest files from Sal
 [![Downloads/week](https://img.shields.io/npm/dw/@jayree/sfdx-plugin-manifest.svg)](https://npmjs.org/package/@jayree/sfdx-plugin-manifest)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/jayree/sfdx-plugin-manifest/main/LICENSE.txt)
 
-## Install
+## Introduction
 
-```bash
-sf plugins:install @jayree/sfdx-plugin-manifest
-```
+`@jayree/sfdx-plugin-manifest` is a Salesforce CLI plugin and Node.js library designed to streamline metadata management and deployment processes. By leveraging Salesforce's native [@salesforce/source-deploy-retrieve](https://github.com/forcedotcom/source-deploy-retrieve) toolkit and [@salesforce/source-tracking](https://github.com/forcedotcom/source-tracking), it ensures compatibility with Salesforce standards. The plugin is particularly effective for incremental deployments and Git-based change tracking, making it a valuable tool for modern Salesforce development workflows.
+
+## Key Features
+
+- **Dual Integration**: Use it as a Salesforce CLI plugin or integrate it into Node.js applications for programmatic workflows.
+- **Native Compatibility**: Built on `@salesforce/source-deploy-retrieve` and `@salesforce/source-tracking`, ensuring alignment with Salesforce's Metadata API standards. Unlike tools with custom metadata handling, this plugin leverages native frameworks for reliability.
+- **Git-Enhanced Deployments**: Simplifies deployment processes by analyzing Git changes and generating precise manifests.
+- **Automated Manifest Creation**: Automatically generate [package.xml](https://trailhead.salesforce.com/en/content/learn/modules/package-xml/package-xml-adventure) files for streamlined deployments.
+- **Intelligent File Tracking**: Detects and excludes renamed or moved files for accurate metadata tracking.
+
+## Why Use @jayree/sfdx-plugin-manifest?
+
+Managing Salesforce metadata across teams and environments can be challenging. This plugin simplifies workflows by automating manifest creation and focusing on incremental deployments based on Git changes. It is ideal for:
+
+- **Collaborative Development**: Streamlines workflows for teams sharing metadata repositories.
+- **CI/CD Pipelines**: Ensures accurate and efficient deployments in automated pipelines.
+- **Error Reduction**: Automates tasks prone to manual errors, like manifest creation.
+
+## Comparison with sfdx-git-delta
+
+Both `@jayree/sfdx-plugin-manifest` and `sfdx-git-delta` are tools designed to simplify Salesforce metadata deployments. However, their **technological basis** differs:
+
+- `@jayree/sfdx-plugin-manifest` is built on Salesforce's native [@salesforce/source-deploy-retrieve](https://github.com/forcedotcom/source-deploy-retrieve), ensuring full compatibility with Salesforce Metadata API standards.
+- `sfdx-git-delta` uses custom metadata handling mechanisms, which are not directly tied to Salesforce's native APIs and frameworks, potentially introducing additional complexity.
+
+By prioritizing native compatibility and programmatic flexibility, `@jayree/sfdx-plugin-manifest` offers a reliable solution for modern Salesforce development. While both tools are specialized for CI/CD workflows, `sfdx-git-delta` provides additional support for a small number of specific edge use cases.
+
+## Installation
 
 > **Note:**
 >
-> The `jayree manifest git diff` command uses the `isomorphic-git` module, which does not support system or global git configurations. Windows users who have `autocrlf` enabled need to set this configuration locally in the repository to enhance the performance of the command.
+> The `jayree manifest git diff` command and the `SDR-extra` library use the `isomorphic-git` module, which does not support system-wide or global Git configurations. If you are a Windows user with `autocrlf` enabled, you must set this configuration locally within your repository to ensure optimal performance.
 >
-> To do this, execute the following command in your repository:
+> To configure it, run the following command in your repository:
 >
 > ```powershell
 > git config --local core.autocrlf true
 > ```
 
+### As a Salesforce CLI Plugin
 
+Install the plugin using the Salesforce CLI:
 
+```bash
+sf plugins install @jayree/sfdx-plugin-manifest
+```
+
+### As a Node.js Module
+
+Add the library to your Node.js project:
+
+```bash
+npm install @jayree/sfdx-plugin-manifest
+```
+
+Initialize a Component Set from Git Commits:
+
+```typescript
+import { ComponentSetExtra } from '@jayree/sfdx-plugin-manifest/lib/SDR-extra/index.js';
+
+(async () => {
+  const fromSingleCommit = await ComponentSetExtra.fromGitDiff(['HEAD~1']);
+  const fromMultipleCommits = await ComponentSetExtra.fromGitDiff([
+    'commit1',
+    'HEAD'
+  ]);
+})();
+```
 
 ## Commands
 
@@ -60,7 +112,7 @@ EXAMPLES
   $ sf jayree manifest cleanup --manifest=package.xml --file=packageignore.xml
 ```
 
-_See code: [src/commands/jayree/manifest/cleanup.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/3.6.23/src/commands/jayree/manifest/cleanup.ts)_
+_See code: [src/commands/jayree/manifest/cleanup.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/3.6.25/src/commands/jayree/manifest/cleanup.ts)_
 
 ### `sf jayree manifest generate`
 
@@ -98,7 +150,7 @@ EXAMPLES
   <Package xmlns='http://soap.sforce.com/2006/04/metadata'>...</Package>
 ```
 
-_See code: [src/commands/jayree/manifest/generate.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/3.6.23/src/commands/jayree/manifest/generate.ts)_
+_See code: [src/commands/jayree/manifest/generate.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/3.6.25/src/commands/jayree/manifest/generate.ts)_
 
 ### `sf jayree manifest git diff REF1 [REF2]`
 
@@ -181,7 +233,7 @@ FLAG DESCRIPTIONS
     The location can be an absolute path or relative to the current working directory.
 ```
 
-_See code: [src/commands/jayree/manifest/git/diff.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/3.6.23/src/commands/jayree/manifest/git/diff.ts)_
+_See code: [src/commands/jayree/manifest/git/diff.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/3.6.25/src/commands/jayree/manifest/git/diff.ts)_
 <!-- commandsstop -->
 
 ## Performance Testing