@syntax-syllogism/flow-delta 0.2.1 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -3
- package/dist/cli.js +733 -317
- package/dist/github-report.js +342 -0
- package/dist/gitlab-report.js +122 -40
- package/examples/cloudflare-worker/src/index.ts +63 -0
- package/examples/cloudflare-worker/wrangler.toml +8 -0
- package/examples/github-actions.yml +56 -0
- package/examples/gitlab-ci.yml +23 -0
- package/package.json +8 -4
- package/scripts/r2-publish.mjs +132 -0
package/README.md
CHANGED
|
@@ -5,10 +5,12 @@ A semantic, visual diff for Salesforce Flows: parse two versions of a
|
|
|
5
5
|
interactive HTML artifact (plus `diff.json`) that shows added / deleted /
|
|
6
6
|
modified / unchanged nodes and edges with per-property deltas.
|
|
7
7
|
|
|
8
|
-
Inspired by Google's [Flow Lens](https://github.com/google/flow-lens), with
|
|
9
|
-
|
|
8
|
+
Inspired by Google's [Flow Lens](https://github.com/google/flow-lens), with a
|
|
9
|
+
focus on CI review workflows for GitLab merge requests and GitHub pull requests.
|
|
10
|
+
We also opted for our own HTML output over plantuml, graphviz, or mermaid.
|
|
10
11
|
|
|
11
|
-
[Sample
|
|
12
|
+
- [Sample GitLab project with artifacts](https://gitlab.com/j.p.richter/flow-delta-example/-/merge_requests/)
|
|
13
|
+
- [Sample GitHub project with artifacts](https://github.com/Syntax-Syllogism/flow-delta-example/pulls)
|
|
12
14
|
|
|
13
15
|
## Usage
|
|
14
16
|
|
|
@@ -19,6 +21,19 @@ for full file-mode and git-mode options.
|
|
|
19
21
|
npx tsx src/cli.ts --old before.flow-meta.xml --new after.flow-meta.xml --out ./flow-delta-out --json
|
|
20
22
|
```
|
|
21
23
|
|
|
24
|
+
CI reporters read the generated `flow-delta-out/*.diff.json` files and post a
|
|
25
|
+
sticky review comment:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
flow-delta-gitlab --in flow-delta-out
|
|
29
|
+
flow-delta-github --in flow-delta-out
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
The GitHub reporter can also consume `--artifact-urls <manifest.json>` for
|
|
33
|
+
user-owned live-render links, such as R2 presigned URLs or Cloudflare
|
|
34
|
+
Worker-backed URLs. See [docs/ci.md](docs/ci.md) for GitLab/GitHub workflow
|
|
35
|
+
recipes, private-repo artifact viewing, and smoke harnesses.
|
|
36
|
+
|
|
22
37
|
## Development
|
|
23
38
|
|
|
24
39
|
```bash
|