Prepare migration to sfdx-git-delta v6 for January 7th, 2025

[scolladon]

What's Changing?

As of November 6th, 2024, Salesforce will deprecate legacy commands. In response, we are upgrading the sfdx-git-delta plugin to version 6, aligning with the sf CLI v2 and following the latest Salesforce CLI guidelines.

Versions v5.x and below will not be maintained anymore (no bug fixes, no new metadata support, no new API version, no new features).

How Will This Impact You?

1. End of Support for sfdx/cli:
   The sfdx/cli will no longer be supported. The plugin will now be compatible exclusively with the salesforce/cli.

2. Updated Output Format:
   The default plugin output will no longer be in JSON. Instead, it will utilize the new UX components introduced in the sf CLI, delivering a more streamlined user experience while adhering to CLI standards.
   For those who still need JSON output, the format will now merge with standard CLI output, with some attributes being removed to avoid redundancy.

3. Switch to ECMAScript Modules (ESM):
   The plugin has transitioned to exporting ESM instead of CommonJS modules. If you’re using sfdx-git-delta in custom scripts, you may need to adjust your import statements accordingly.

4. Deprecated Parameters:
   The file and directory parameters will be replaced with new alternatives, in line with CLI guidelines. This includes improved error handling, which will now be delegated to the CLI for a more consistent experience.

Why Are We Making These Changes?

Our goal is to:

• Align with Salesforce's strategic direction and the latest CLI standards.
• Provide users with improved performance, enhanced security, and access to the latest CLI features.
• Ensure that sfdx-git-delta continues to deliver a high-quality and up-to-date experience.

Why Now?

While major changes can be challenging, we believe now is the right time for this transition because:

• The sfdx/cli has been deprecated for over a year.
• Salesforce is phasing out older command sets.
• The majority of our user base has already adopted salesforce/cli (currently at 2/3 vs. 1/3 on sfdx/cli).
• Older plugin versions will remain available but will no longer be maintained.

By making this transition close to Salesforce’s deprecation timeline, we aim to provide a smoother migration path for users.

What if I need to stay on v5?

Follow the instructions in the migration guide

Additional Resources

• Migration Guide to sfdx-git-delta v6
• Focus on sfdx-git-delta version installation

Questions or Feedback?

If you have any questions or feedback, feel free to comment on this issue.
We also encourage you to beta test version 6 (instructions here) — your input is invaluable!

[github-actions]

Shipped in release v6.0.0.
Version v6.0.0 will be assigned to the latest npm channel soon
Install it using either v6.0.0 or the latest-rc npm channel

$ sf plugins install sfdx-git-delta@latest-rc
# Or
$ sf plugins install [email protected]

💡 Enjoying sfdx-git-delta?
Your contribution helps us provide fast support 🚀 and high quality features 🔥
Become a sponsor 💙
Happy incremental deployment!