simonscholz/Newman/Postman action with different outputs

Run postman collections via GitHub actions using newman 6.0.0 + run summaries as action output for further notifications.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
apiKeyPostman API keyno
collectionThe exported collection.json to be run or URL to the collection, which needs the `apiKey` propertyyes""
environmentThe environment.json to be used or URL to the environment, which needs the `apiKey` propertyno
envVarAdditional environment variables, which can also override the ones from the `environment`.no
globalsThe globals.json to be usedno
globalVarAdditional global variables, which can also override the ones from the `globals`.no
exportGlobalsThe relative path to export the globals file from the current runno
exportEnvironmentThe relative path to export the environment file from the current runno
exportCollectionThe relative path to export the collection from the current runno
iterationCountSpecify the number of iterations to run on the collection. This is usually accompanied by providing a data file reference as `iterationData`.no
iterationDataPath to the JSON or CSV file or URL to be used as a data source when running multiple iterations on a collection.no
folderThe name or ID of the folder (ItemGroup) in the collection which would be run instead of the entire collection.no
workingDirThe path of the directory to be used as the working directory.no
insecureFileReadAllow reading files outside of the working directory. (type: boolean)no
timeoutSpecify the time (in milliseconds) to wait for the entire collection run to complete execution. (type: number)noInfinity
timeoutRequestSpecify the time (in milliseconds) to wait for requests to return a response. (type: number)noInfinity
timeoutScriptSpecify the time (in milliseconds) to wait for scripts to return a response. (type: number)noInfinity
delayRequestSpecify the time (in milliseconds) to wait for between subsequent requests. (type: number)no0
ignoreRedirectsThis specifies whether Newman would automatically follow 3xx responses from servers. (type: boolean)nofalse
insecureDisables SSL verification checks and allows self-signed SSL certificates. (type: boolean)nofalse
bailSpecify whether or not to stop a collection run on encountering the first test script error. "folder" allows you to skip the entire collection run in case an invalid folder was specified using the `folder` option or an error was encountered in general. "failure" would gracefully stop a collection run after completing the current test script. (possible values: `true` or `false` or `folder` or `failure`)nofalse
suppressExitCodeIf present, allows overriding the default exit code from the current collection run, useful for bypassing collection result failures. (type: boolean)nofalse
reportersAvailable reporters: cli, json, html, and junit.nocli
reporterSpecify options for the reporter(s) declared in options.reporters. (type: any)no
colorEnable or Disable colored CLI output. (possible values: `on` or `of` or `auto`)noauto
sslClientCertThe path to the public client certificate file.no
sslClientKeyThe path to the private client key file.no
sslClientPassphraseThe secret client key passphrase.no
sslClientCertListThe path to the client certificate configuration list file. This option takes precedence over sslClientCert, sslClientKey, and slClientPassphrase. When there is no match in this configuration list, sslClientCert is used as a fallback.no
sslExtraCaCertsThe path to the file that holds one or more trusted CA certificates in PEM format.no
requestAgentsCustom HTTP(S) agents which will be used for making the requests. This allows for the use of various proxies (e.g. socks)no
cookieJarA tough-cookie cookieJar / file path for the current collection run.no
outputOriginalSummaryWhether the original summary object of the newman run should be set as output or not (type: `boolean`)nofalse
outputGoogleCardV2Whether the google cards v2 sections array should be set as output or not (type: `boolean`)nofalse
namedescription
summaryA lightweight summary json object of the newman run
originalSummaryThe original summary json object of the newman run
googleCardV2The output, which can be used as structure for the google chat card v2