Skip to content

Commit b874363

Browse files
icecrasher321icecrasher321
committed
fix(workflows): unify version comparison and simplify diff UI
1 parent 5793bb2 commit b874363

56 files changed

Lines changed: 2132 additions & 3100 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎apps/docs/content/docs/api-reference/(generated)/workflows/meta.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
"applyWorkflowVariables",
1515
"listWorkflowVersionsV2",
1616
"getWorkflowVersionV2",
17+
"compareWorkflowVersionsV2",
1718
"updateWorkflowVersionV2",
1819
"activateWorkflowVersion",
1920
"revertWorkflowVersion",

‎apps/docs/content/docs/cli/reference.mdx‎

Lines changed: 107 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -6277,6 +6277,113 @@ sim workflows runs wait <runId> [options]
62776277

62786278
</CommandTable>
62796279

6280+
### sim workflows versions compare
6281+
6282+
Compare Workflow Versions
6283+
6284+
```bash
6285+
sim workflows versions compare <workflowId> [options]
6286+
```
6287+
6288+
**Arguments**
6289+
6290+
<CommandTable>
6291+
6292+
| Argument | Required | Description |
6293+
| --- | --- | --- |
6294+
| `workflowId` | Yes | Unique workflow identifier. |
6295+
6296+
</CommandTable>
6297+
6298+
**Options**
6299+
6300+
<CommandTable>
6301+
6302+
| Option | Required | Description |
6303+
| --- | --- | --- |
6304+
| `--base <value>` | Yes | Deployment version to compare from. |
6305+
| `--target <value>` | Yes | Deployment version to compare to, in the same workflow. |
6306+
6307+
</CommandTable>
6308+
6309+
### sim workflows versions get
6310+
6311+
Get Workflow Version
6312+
6313+
```bash
6314+
sim workflows versions get <workflowId> <version>
6315+
```
6316+
6317+
**Arguments**
6318+
6319+
<CommandTable>
6320+
6321+
| Argument | Required | Description |
6322+
| --- | --- | --- |
6323+
| `workflowId` | Yes | Unique workflow identifier. |
6324+
| `version` | Yes | Numeric deployment version. |
6325+
6326+
</CommandTable>
6327+
6328+
### sim workflows versions list
6329+
6330+
List Workflow Versions
6331+
6332+
```bash
6333+
sim workflows versions list <workflowId> [options]
6334+
```
6335+
6336+
**Arguments**
6337+
6338+
<CommandTable>
6339+
6340+
| Argument | Required | Description |
6341+
| --- | --- | --- |
6342+
| `workflowId` | Yes | Unique workflow identifier. |
6343+
6344+
</CommandTable>
6345+
6346+
**Options**
6347+
6348+
<CommandTable>
6349+
6350+
| Option | Required | Description |
6351+
| --- | --- | --- |
6352+
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
6353+
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |
6354+
6355+
</CommandTable>
6356+
6357+
### sim workflows versions update
6358+
6359+
Update Workflow Version
6360+
6361+
```bash
6362+
sim workflows versions update <workflowId> <version> [options]
6363+
```
6364+
6365+
**Arguments**
6366+
6367+
<CommandTable>
6368+
6369+
| Argument | Required | Description |
6370+
| --- | --- | --- |
6371+
| `workflowId` | Yes | Unique workflow identifier. |
6372+
| `version` | Yes | Numeric deployment version. |
6373+
6374+
</CommandTable>
6375+
6376+
**Options**
6377+
6378+
<CommandTable>
6379+
6380+
| Option | Required | Description |
6381+
| --- | --- | --- |
6382+
| `--name <value>` | No | New label for the deployment version. |
6383+
| `--description <value>` | No | New release note for the deployment version, or null to clear it. (--description null sends the word, not JSON null). |
6384+
6385+
</CommandTable>
6386+
62806387
### sim workflows create
62816388

62826389
Create Workflow
@@ -6750,84 +6857,6 @@ sim workflows state replace <workflowId> [options]
67506857

67516858
</CommandTable>
67526859

6753-
### sim workflows versions get
6754-
6755-
Get Workflow Version
6756-
6757-
```bash
6758-
sim workflows versions get <workflowId> <version>
6759-
```
6760-
6761-
**Arguments**
6762-
6763-
<CommandTable>
6764-
6765-
| Argument | Required | Description |
6766-
| --- | --- | --- |
6767-
| `workflowId` | Yes | Unique workflow identifier. |
6768-
| `version` | Yes | Numeric deployment version. |
6769-
6770-
</CommandTable>
6771-
6772-
### sim workflows versions list
6773-
6774-
List Workflow Versions
6775-
6776-
```bash
6777-
sim workflows versions list <workflowId> [options]
6778-
```
6779-
6780-
**Arguments**
6781-
6782-
<CommandTable>
6783-
6784-
| Argument | Required | Description |
6785-
| --- | --- | --- |
6786-
| `workflowId` | Yes | Unique workflow identifier. |
6787-
6788-
</CommandTable>
6789-
6790-
**Options**
6791-
6792-
<CommandTable>
6793-
6794-
| Option | Required | Description |
6795-
| --- | --- | --- |
6796-
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
6797-
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |
6798-
6799-
</CommandTable>
6800-
6801-
### sim workflows versions update
6802-
6803-
Update Workflow Version
6804-
6805-
```bash
6806-
sim workflows versions update <workflowId> <version> [options]
6807-
```
6808-
6809-
**Arguments**
6810-
6811-
<CommandTable>
6812-
6813-
| Argument | Required | Description |
6814-
| --- | --- | --- |
6815-
| `workflowId` | Yes | Unique workflow identifier. |
6816-
| `version` | Yes | Numeric deployment version. |
6817-
6818-
</CommandTable>
6819-
6820-
**Options**
6821-
6822-
<CommandTable>
6823-
6824-
| Option | Required | Description |
6825-
| --- | --- | --- |
6826-
| `--name <value>` | No | New label for the deployment version. |
6827-
| `--description <value>` | No | New release note for the deployment version, or null to clear it. (--description null sends the word, not JSON null). |
6828-
6829-
</CommandTable>
6830-
68316860
### sim workflows import
68326861

68336862
Import Workflow

‎apps/docs/content/docs/cli/workflows.mdx‎

Lines changed: 99 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -239,6 +239,105 @@ sim workflows runs wait <runId> [options]
239239

240240
</CommandTable>
241241

242+
## Compare workflow versions
243+
244+
```bash
245+
sim workflows versions compare <workflowId> [options]
246+
```
247+
248+
**Arguments**
249+
250+
<CommandTable>
251+
252+
| Argument | Required | Description |
253+
| --- | --- | --- |
254+
| `workflowId` | Yes | Unique workflow identifier. |
255+
256+
</CommandTable>
257+
258+
**Options**
259+
260+
<CommandTable>
261+
262+
| Option | Required | Description |
263+
| --- | --- | --- |
264+
| `--base <value>` | Yes | Deployment version to compare from. |
265+
| `--target <value>` | Yes | Deployment version to compare to, in the same workflow. |
266+
267+
</CommandTable>
268+
269+
## Get workflow version
270+
271+
```bash
272+
sim workflows versions get <workflowId> <version>
273+
```
274+
275+
**Arguments**
276+
277+
<CommandTable>
278+
279+
| Argument | Required | Description |
280+
| --- | --- | --- |
281+
| `workflowId` | Yes | Unique workflow identifier. |
282+
| `version` | Yes | Numeric deployment version. |
283+
284+
</CommandTable>
285+
286+
## List workflow versions
287+
288+
```bash
289+
sim workflows versions list <workflowId> [options]
290+
```
291+
292+
**Arguments**
293+
294+
<CommandTable>
295+
296+
| Argument | Required | Description |
297+
| --- | --- | --- |
298+
| `workflowId` | Yes | Unique workflow identifier. |
299+
300+
</CommandTable>
301+
302+
**Options**
303+
304+
<CommandTable>
305+
306+
| Option | Required | Description |
307+
| --- | --- | --- |
308+
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
309+
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |
310+
311+
</CommandTable>
312+
313+
## Update workflow version
314+
315+
```bash
316+
sim workflows versions update <workflowId> <version> [options]
317+
```
318+
319+
**Arguments**
320+
321+
<CommandTable>
322+
323+
| Argument | Required | Description |
324+
| --- | --- | --- |
325+
| `workflowId` | Yes | Unique workflow identifier. |
326+
| `version` | Yes | Numeric deployment version. |
327+
328+
</CommandTable>
329+
330+
**Options**
331+
332+
<CommandTable>
333+
334+
| Option | Required | Description |
335+
| --- | --- | --- |
336+
| `--name <value>` | No | New label for the deployment version. |
337+
| `--description <value>` | No | New release note for the deployment version, or null to clear it. (--description null sends the word, not JSON null). |
338+
339+
</CommandTable>
340+
242341
## Create workflow
243342

244343
```bash
@@ -688,78 +787,6 @@ Replace Workflow State (OAuth login or personal API key required)
688787

689788
</CommandTable>
690789

691-
## Get workflow version
692-
693-
```bash
694-
sim workflows versions get <workflowId> <version>
695-
```
696-
697-
**Arguments**
698-
699-
<CommandTable>
700-
701-
| Argument | Required | Description |
702-
| --- | --- | --- |
703-
| `workflowId` | Yes | Unique workflow identifier. |
704-
| `version` | Yes | Numeric deployment version. |
705-
706-
</CommandTable>
707-
708-
## List workflow versions
709-
710-
```bash
711-
sim workflows versions list <workflowId> [options]
712-
```
713-
714-
**Arguments**
715-
716-
<CommandTable>
717-
718-
| Argument | Required | Description |
719-
| --- | --- | --- |
720-
| `workflowId` | Yes | Unique workflow identifier. |
721-
722-
</CommandTable>
723-
724-
**Options**
725-
726-
<CommandTable>
727-
728-
| Option | Required | Description |
729-
| --- | --- | --- |
730-
| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. |
731-
| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. |
732-
733-
</CommandTable>
734-
735-
## Update workflow version
736-
737-
```bash
738-
sim workflows versions update <workflowId> <version> [options]
739-
```
740-
741-
**Arguments**
742-
743-
<CommandTable>
744-
745-
| Argument | Required | Description |
746-
| --- | --- | --- |
747-
| `workflowId` | Yes | Unique workflow identifier. |
748-
| `version` | Yes | Numeric deployment version. |
749-
750-
</CommandTable>
751-
752-
**Options**
753-
754-
<CommandTable>
755-
756-
| Option | Required | Description |
757-
| --- | --- | --- |
758-
| `--name <value>` | No | New label for the deployment version. |
759-
| `--description <value>` | No | New release note for the deployment version, or null to clear it. (--description null sends the word, not JSON null). |
760-
761-
</CommandTable>
762-
763790
## Import workflow
764791

765792
```bash

0 commit comments

Comments
 (0)