@simplysf/simply 6.10.7 → 6.12.0

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 CHANGED
@@ -2546,7 +2546,7 @@ FLAG DESCRIPTIONS
2546
2546
  The path to write the generated HTML report to.
2547
2547
  ```
2548
2548
 
2549
- _See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@1.4.4/packages/simply-permissions/lib/commands/simply/permissions/analyze.js)_
2549
+ _See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@1.6.0/packages/simply-permissions/lib/commands/simply/permissions/analyze.js)_
2550
2550
 
2551
2551
  ## `sf simply permissions assignment delete`
2552
2552
 
@@ -2589,7 +2589,7 @@ EXAMPLES
2589
2589
  $ sf simply permissions assignment delete --permission-set-group-name My_Permission_Set_Group --target-org myOrg
2590
2590
  ```
2591
2591
 
2592
- _See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@1.4.4/packages/simply-permissions/lib/commands/simply/permissions/assignment/delete.js)_
2592
+ _See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@1.6.0/packages/simply-permissions/lib/commands/simply/permissions/assignment/delete.js)_
2593
2593
 
2594
2594
  ## `sf simply permissions build`
2595
2595
 
@@ -2599,12 +2599,14 @@ Generate permission sets from Salesforce source metadata.
2599
2599
  USAGE
2600
2600
  $ sf simply permissions build [--json] [--flags-dir <value>] [-f <value> | --type read-only|view-all|modify-all | -n <value>
2601
2601
  | -d <value> | --output <value> | -c <value> | --include-record-types | --label <value> | --description <value>]
2602
+ [--check]
2602
2603
 
2603
2604
  FLAGS
2604
2605
  -c, --config=<value> Path to a permission set configuration file
2605
2606
  -d, --directory=<value> Path to the Salesforce project directory
2606
2607
  -f, --file=<value> Path to a permission sets file declaring every permission set to generate
2607
2608
  -n, --name=<value> API name for the permission set
2609
+ --check Check that the generated permission sets are up to date, without writing them
2608
2610
  --description=<value> Description for the permission set
2609
2611
  --include-record-types Include record type visibilities
2610
2612
  --label=<value> Label for the permission set
@@ -2630,7 +2632,9 @@ DESCRIPTION
2630
2632
  shared by every entry, and any entry can override them. An entry's "config" is either a path to a --config file or the
2631
2633
  same overrides inline. Relative paths are resolved against the current directory, as they are for flags. The whole
2632
2634
  file, including referenced override files and source directories, is validated before anything is written, and each
2633
- source directory is scanned only once.
2635
+ source directory is scanned only once. Name the file with the .psbuild.json suffix (for example
2636
+ config/app.psbuild.json): that's how `sf simply cicd build check-permission-sets` finds permission sets files, and
2637
+ this command warns about a file without it.
2634
2638
 
2635
2639
  {
2636
2640
  "defaults": {
@@ -2654,6 +2658,12 @@ DESCRIPTION
2654
2658
  ]
2655
2659
  }
2656
2660
 
2661
+ To check in CI that the committed permission sets still match their source metadata, add --check. It builds each
2662
+ permission set as usual but writes nothing: it compares each one with the file already at its output path and reports
2663
+ it as "up-to-date", "drifted", or "missing". If any permission set has drifted or is missing, the command exits with
2664
+ code 1. Formatting differences, such as indentation, line endings, or comments, don't count as drift, so files
2665
+ reformatted by Prettier still pass. Any other difference does, including hand edits and reordered entries.
2666
+
2657
2667
  EXAMPLES
2658
2668
  $ sf simply permissions build --type read-only --name My_Read_Only_Access --directory force-app --output force-app/main/default/permissionsets
2659
2669
 
@@ -2661,7 +2671,11 @@ EXAMPLES
2661
2671
 
2662
2672
  Regenerate every permission set declared in a permission sets file:
2663
2673
 
2664
- $ sf simply permissions build --file config/permission-sets.json
2674
+ $ sf simply permissions build --file config/app.psbuild.json
2675
+
2676
+ In CI, fail if any permission set declared in a permission sets file needs to be regenerated:
2677
+
2678
+ $ sf simply permissions build --file config/app.psbuild.json --check
2665
2679
 
2666
2680
  FLAG DESCRIPTIONS
2667
2681
  -c, --config=<value> Path to a permission set configuration file
@@ -2678,13 +2692,20 @@ FLAG DESCRIPTIONS
2678
2692
 
2679
2693
  The path to a JSON file with a "permissionSets" array, each entry describing one permission set to generate ("name",
2680
2694
  "type", and optionally "label", "description", "directory", "output", "includeRecordTypes", "config"), and an
2681
- optional "defaults" object. Can't be combined with the flags that describe a single permission set.
2695
+ optional "defaults" object. Name it with the .psbuild.json suffix; any other name works but prints a warning. Can't
2696
+ be combined with the flags that describe a single permission set.
2682
2697
 
2683
2698
  -n, --name=<value> API name for the permission set
2684
2699
 
2685
2700
  The API name for the generated permission set; also used to derive the output filename. Required unless --file is
2686
2701
  used.
2687
2702
 
2703
+ --check Check that the generated permission sets are up to date, without writing them
2704
+
2705
+ Instead of writing each permission set, compare what would be generated with the file already at its output path.
2706
+ Exits with code 1 if any permission set has drifted or is missing. Works with --file and with the
2707
+ single-permission-set flags.
2708
+
2688
2709
  --include-record-types Include record type visibilities
2689
2710
 
2690
2711
  Automatically include record type visibilities discovered from the source metadata, marked as visible by default.
@@ -2700,7 +2721,7 @@ FLAG DESCRIPTIONS
2700
2721
  Required unless --file is used.
2701
2722
  ```
2702
2723
 
2703
- _See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@1.4.4/packages/simply-permissions/lib/commands/simply/permissions/build.js)_
2724
+ _See code: [@simplysf/simply-permissions](https://github.com/SimplySF/simply-plugins/blob/@simplysf/simply-permissions@1.6.0/packages/simply-permissions/lib/commands/simply/permissions/build.js)_
2704
2725
 
2705
2726
  ## `sf simply project update api-version`
2706
2727
 
@@ -1,4 +1,4 @@
1
1
  {
2
2
  "commands": {},
3
- "version": "6.10.7"
3
+ "version": "6.12.0"
4
4
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@simplysf/simply",
3
3
  "description": "Salesforce CLI Plugins created by @SimplySF",
4
- "version": "6.10.7",
4
+ "version": "6.12.0",
5
5
  "author": "@ClayChipps",
6
6
  "homepage": "https://github.com/SimplySF/simply-plugins",
7
7
  "bugs": "https://github.com/SimplySF/simply-plugins/issues",
@@ -83,7 +83,7 @@
83
83
  "@simplysf/simply-document": "^0.4.13",
84
84
  "@simplysf/simply-flow": "^0.4.16",
85
85
  "@simplysf/simply-package": "^3.1.7",
86
- "@simplysf/simply-permissions": "^1.4.4",
86
+ "@simplysf/simply-permissions": "^1.6.0",
87
87
  "@simplysf/simply-project": "^1.2.29",
88
88
  "@simplysf/simply-schema": "^0.3.34",
89
89
  "@simplysf/simply-settings": "^0.3.2",
@@ -180,5 +180,5 @@
180
180
  "output": []
181
181
  }
182
182
  },
183
- "gitHead": "7bd4cc96688ad9379ae8440a6a945f61d1d004bc"
183
+ "gitHead": "cfc320bc665f61d2ab5c702ea9120bddc34b6078"
184
184
  }