update readme

README.md

@@ -107,6 +107,8 @@ Options:
  --newmanIterationData, -d Iteration data to run Newman with newly created collection [string]
  --localPostman Use local Postman collection, skips OpenAPI conversion [string]
  --syncPostman Upload generated collection to Postman (default: false) [boolean]
+ --syncPostmanCollectionIds Synchronises the IDs of newly created postman collections with those already
+ on Postman, useful when you want to use Postman pull request (default: false) [boolean]
  --postmanFastSync Postman sync creates new collection (new UID),instead of update (default: false) [boolean]
  --postmanRefreshCache Postman sync will refresh all local cached Postman API data (default: false) [boolean]
  --postmanUid, -p Postman collection UID to upload with the generated Postman collection [string]

examples/cli-options/portman-cli-options.json

@@ -7,6 +7,7 @@
  "envFile": "./examples/cli-options/.lead.env",
  "includeTests": true,
  "syncPostman": false,
+ "syncPostmanCollectionIds": false,
  "runNewman": false,
  "oaRename": "CRM API - Test suite"
 }

examples/cli-options/portman-cli-options.yaml

@@ -6,6 +6,7 @@ postmanConfigFile: ./examples/cli-options/postman-config.crm.json
 envFile: ./examples/cli-options/.lead.env
 includeTests: true
 syncPostman: false
+syncPostmanCollectionIds: false
 runNewman: false
 oaRename: 'CRM API - Test suite'
 

examples/cli-options/readme.md

@@ -30,6 +30,7 @@ portman --cliOptionsFile ./examples/cli-options/portman-cli-options.yaml
  "envFile": "./examples/cli-options/.lead.env",
  "includeTests": true,
  "syncPostman": false,
+ "syncPostmanCollectionIds": false,
  "runNewman": false,
  "oaRename": "CRM API - Test suite"
 }
@@ -46,6 +47,7 @@ postmanConfigFile: ./examples/cli-options/postman-config.crm.json
 envFile: ./examples/cli-options/.lead.env
 includeTests: true
 syncPostman: false
+syncPostmanCollectionIds: false
 runNewman: false
 oaRename: 'CRM API - Test suite'
 ```
@@ -66,9 +68,18 @@ pipeline
 - **includeTests**: a toggle to generate Postman tests based on the OpenAPI specification
 - **postmanUid**: refers to the collection ID to upload the generated collection to your postman app
 - **syncPostman**: a toggle to upload the newly created collection to the Postman app
+- **syncPostmanCollectionIds**: Synchronises the IDs of newly created postman collections with those already on Postman, useful when you want to use Postman pull request
 - **runNewman**: a toggle to run Newman on a newly created collection
 - **oaRename**: Change the OpenAPI title & Postman collection name to 'CRM API - Test suite'. This might be handy if you want to have your original Postman collection and your Portman generated Postman collection as separate collections.
 
+### syncPostmanCollectionIds 
+
+BEFORE
+![](./images/postman-sync-postman-collection-ids-disabled.png)
+
+AFTER
+![](./images/postman-sync-postman-collection-ids-enabled.png)
+
 ## Portman Newman CLI options
 
 One of the Portman CLI options is to test the generated Postman collection, through Newman.