sf-decomposer 7.2.0 → 7.3.1

package/CHANGELOG.md

@@ -5,6 +5,21 @@
 
 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.
 
+## [7.3.1](https://github.com/mcarvin8/sf-decomposer/compare/v7.3.0...v7.3.1) (2026-08-25)
+
+
+### Bug Fixes
+
+* **deps:** bump the dependencies group across 1 directory with 3 updates ([#570](https://github.com/mcarvin8/sf-decomposer/issues/570)) ([eb03301](https://github.com/mcarvin8/sf-decomposer/commit/eb033016f168605668f33fe14ce9904e8b2f11fb))
+* **package:** exclude lib/action from npm package ([af56788](https://github.com/mcarvin8/sf-decomposer/commit/af567883d2763e7224b1f7b13ef35add1658fecf))
+
+## [7.3.0](https://github.com/mcarvin8/sf-decomposer/compare/v7.2.0...v7.3.0) (2026-08-24)
+
+
+### Features
+
+* **action:** add a GitHub Action wrapping decompose/recompose/verify ([#572](https://github.com/mcarvin8/sf-decomposer/issues/572)) ([b32391d](https://github.com/mcarvin8/sf-decomposer/commit/b32391dff7dd2d77868b4a67cc70f7563dd1e55b))
+
 ## [7.2.0](https://github.com/mcarvin8/sf-decomposer/compare/v7.1.1...v7.2.0) (2026-08-24)
 
 

package/README.md

@@ -2,13 +2,17 @@
 
 [![NPM](https://img.shields.io/npm/v/sf-decomposer.svg?label=sf-decomposer)](https://www.npmjs.com/package/sf-decomposer)
 [![Downloads/week](https://img.shields.io/npm/dw/sf-decomposer.svg)](https://npmjs.com/package/sf-decomposer)
+[![GitHub Marketplace](https://img.shields.io/badge/marketplace-sf--decomposer-blue?logo=github)](https://github.com/marketplace/actions/sf-decomposer)
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/mcarvin8/sf-decomposer/main/LICENSE.md)
 [![Maintainability](https://qlty.sh/badges/8492c1c6-0f93-4d37-bfad-32fd3b788a2d/maintainability.svg)](https://qlty.sh/gh/mcarvin8/projects/sf-decomposer)
 [![codecov](https://codecov.io/gh/mcarvin8/sf-decomposer/graph/badge.svg?token=YFU52L4XM5)](https://codecov.io/gh/mcarvin8/sf-decomposer)
 [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fmcarvin8%2Fsf-decomposer%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/mcarvin8/sf-decomposer/main)
 [![Performance](https://img.shields.io/badge/Performance-Dashboard-58a6ff)](https://mcarvin8.github.io/sf-decomposer/dev/bench/runtime/)
 
-A Salesforce CLI plugin that **decomposes** large metadata XML files into smaller, version-control–friendly files (XML, JSON, YAML, JSON5), and **recomposes** them back into deployment-ready metadata.
+**Decomposes** large Salesforce metadata XML files into smaller, version-control–friendly files (XML, JSON, YAML, JSON5), and **recomposes** them back into deployment-ready metadata — as a Salesforce CLI plugin, or as a GitHub Action that needs neither the CLI nor a plugin install.
+
+- Using the Salesforce CLI? Start at [Setup](#setup).
+- Running this in CI without the CLI? Skip straight to [GitHub Action](#github-action).
 
 <!-- TABLE OF CONTENTS -->
 <details>
@@ -21,6 +25,7 @@ A Salesforce CLI plugin that **decomposes** large metadata XML files into smalle
   - [4. Configure Hooks](#4-configure-hooks-recommended)
 - [Daily Workflow](#daily-workflow)
 - [Commands](#commands)
+- [GitHub Action](#github-action)
 - [Reference](#reference)
   - [Decompose Strategies](#decompose-strategies)
   - [Supported Metadata](#supported-metadata)
@@ -215,7 +220,7 @@ EXAMPLES
   `sf decomposer decompose -x "manifest/package.xml" -m "flow"`
 ```
 
-_See code: [src/commands/decomposer/decompose.ts](https://github.com/mcarvin8/sf-decomposer/blob/v7.2.0/src/commands/decomposer/decompose.ts)_
+_See code: [src/commands/decomposer/decompose.ts](https://github.com/mcarvin8/sf-decomposer/blob/v7.3.1/src/commands/decomposer/decompose.ts)_
 
 ## `sf decomposer recompose`
 
@@ -261,7 +266,7 @@ EXAMPLES
   `sf decomposer recompose -x "manifest/package.xml" -m "flow"`
 ```
 
-_See code: [src/commands/decomposer/recompose.ts](https://github.com/mcarvin8/sf-decomposer/blob/v7.2.0/src/commands/decomposer/recompose.ts)_
+_See code: [src/commands/decomposer/recompose.ts](https://github.com/mcarvin8/sf-decomposer/blob/v7.3.1/src/commands/decomposer/recompose.ts)_
 
 ## `sf decomposer verify`
 
@@ -325,11 +330,59 @@ EXAMPLES
   `sf decomposer verify -x "manifest/package.xml" --config`
 ```
 
-_See code: [src/commands/decomposer/verify.ts](https://github.com/mcarvin8/sf-decomposer/blob/v7.2.0/src/commands/decomposer/verify.ts)_
+_See code: [src/commands/decomposer/verify.ts](https://github.com/mcarvin8/sf-decomposer/blob/v7.3.1/src/commands/decomposer/verify.ts)_
 <!-- commandsstop -->
 
 ---
 
+## GitHub Action
+
+`decompose`, `recompose`, and `verify` are also available as a GitHub Action — a container action, so it needs **no Salesforce CLI and no `sf-decomposer` plugin install**. One action, dispatched by a `mode` input, mirrors the three CLI commands one-for-one: same flags (as inputs), same `.sfdecomposer.config.json` support via `config: true`.
+
+```yaml
+- uses: actions/checkout@v7
+
+- name: Decompose retrieved metadata
+  uses: mcarvin8/sf-decomposer@v7
+  with:
+    mode: decompose
+    metadata-type: |
+      permissionset
+      flow
+    postpurge: 'true'
+
+- name: Verify the round trip before merging
+  uses: mcarvin8/sf-decomposer@v7
+  with:
+    mode: verify
+    config: 'true'
+```
+
+Or point it at an existing `.sfdecomposer.config.json` for either step instead of listing flags: `with: { mode: decompose, config: 'true' }`.
+
+**Inputs** (all optional except `mode`; multi-value inputs are newline-separated, matching `actions/checkout`'s own multiline convention):
+
+| Input                          | Used by              | Description                                                                       |
+|--------------------------------|----------------------|-----------------------------------------------------------------------------------|
+| `mode`                         | all                  | `decompose`, `recompose`, or `verify`.                                            |
+| `metadata-type`                | all                  | Metadata suffix(es) to process, one per line.                                     |
+| `manifest`                     | all                  | Path to a package.xml manifest to scope the run to.                               |
+| `ignore-package-directory`     | all                  | Package director(y/ies) to skip, one per line.                                    |
+| `config`                       | all                  | Read settings from `.sfdecomposer.config.json`, same as the CLI's `--config`.     |
+| `format`                       | decompose, verify    | `xml`, `json`, `json5`, or `yaml`. Default `xml`.                                 |
+| `strategy`                     | decompose, verify    | `unique-id` or `grouped-by-tag`. Default `unique-id`.                             |
+| `decompose-nested-permissions` | decompose, verify    | With `grouped-by-tag`, further decompose permission set object/field permissions. |
+| `prepurge`                     | decompose            | Remove existing decomposed files before decomposing.                              |
+| `postpurge`                    | decompose, recompose | After decompose, remove originals; after recompose, remove decomposed files.      |
+| `update-forceignore`           | decompose            | Append decomposed file patterns to `.forceignore`.                                |
+| `update-gitattributes`         | decompose            | Mark decomposed files as generated in `.gitattributes`.                           |
+
+**Outputs:** `metadata` (newline-separated list of processed suffixes), `types-count`; `verify` additionally sets `drift-count` and `reordered-count`, and fails the step when `drift-count` is greater than 0.
+
+See [`action.yml`](action.yml) for the full input/output reference.
+
+---
+
 ## Reference
 
 ### Decompose Strategies

package/oclif.manifest.json

@@ -364,5 +364,5 @@
       ]
     }
   },
-  "version": "7.2.0"
+  "version": "7.3.1"
 }

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "sf-decomposer",
   "description": "Decompose Salesforce metadata into granular, VCS-friendly files; recompose for deployment.",
-  "version": "7.2.0",
+  "version": "7.3.1",
   "dependencies": {
-    "@oclif/core": "4.13.5",
-    "@salesforce/core": "9.1.2",
-    "@salesforce/sf-plugins-core": "13.0.0",
+    "@oclif/core": "4.14.0",
+    "@salesforce/core": "9.1.5",
+    "@salesforce/sf-plugins-core": "13.0.3",
     "config-disassembler": "3.3.0"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.5.9",
+    "@actions/core": "3.0.1",
+    "@biomejs/biome": "2.5.10",
     "@commitlint/cli": "21.2.2",
     "@commitlint/config-conventional": "21.2.2",
     "@salesforce/cli-plugins-testkit": "5.3.66",
@@ -17,7 +18,7 @@
     "@stryker-mutator/core": "10.0.0",
     "@stryker-mutator/vitest-runner": "10.0.0",
     "@types/node": "26.2.0",
-    "@vitest/coverage-v8": "4.1.10",
+    "@vitest/coverage-v8": "4.1.11",
     "husky": "9.1.7",
     "knip": "6.32.2",
     "lint-staged": "17.3.0",
@@ -26,7 +27,7 @@
     "shx": "0.4.0",
     "tsx": "4.23.12",
     "typescript": "7.0.2",
-    "vitest": "4.1.10",
+    "vitest": "4.1.11",
     "wireit": "0.14.13"
   },
   "engines": {
@@ -34,6 +35,7 @@
   },
   "files": [
     "/lib",
+    "!/lib/action/**",
     "/messages",
     "/oclif.manifest.json",
     "/oclif.lock",