rechtlogisch/postman repository overview

⁠Node.js with Postman CLI

A custom image for CI pipelines to sign in to Postman and run a collection.

Based on the currently supported stable Node.js slim images (node⁠).

Features:

• Node.js 22 / Node.js 24 / Node.js 26 / Node.js LTS (based on tags⁠)
• Postman CLI⁠ (postman)
• Standard setup requires just two environment variables
• Customizable runtime usage with additional environment variables

This Dockerfile is built with a GitHub Workflow⁠. A dispatched run publishes linux/amd64 and linux/arm64 images for each Node.js tag to Docker Hub and GitHub Container Registry.

⁠Usage

Use ghcr.io/rechtlogisch/postman or rechtlogisch/postman. Tags follow the Node.js major versions, plus lts.

POSTMAN_COLLECTION is required. Set POSTMAN_API_KEY for a collection in the Postman cloud. A collection file on disk can run without a key. With the image defaults, the entrypoint logs in when a key is present and runs:

postman collection run "$POSTMAN_COLLECTION" --reporters cli,junit --reporter-junit-export /reports/report.xml

A local collection file skips login when POSTMAN_API_KEY is unset:

docker run --rm \
  -e POSTMAN_COLLECTION=/work/collection.json \
  -v "$PWD:/work" \
  ghcr.io/rechtlogisch/postman:lts

Mount a host directory on /reports to keep the JUnit file.

docker run --rm \
  -e POSTMAN_API_KEY \
  -e POSTMAN_COLLECTION=12345678-1234-1234-1234-123456789012 \
  -v "$PWD/reports:/reports" \
  ghcr.io/rechtlogisch/postman:lts

Words after the image name are appended to postman collection run. Use them for an environment, a data file, --bail, or any other CLI flag:

docker run --rm \
  -e POSTMAN_API_KEY \
  -e POSTMAN_COLLECTION \
  ghcr.io/rechtlogisch/postman:lts \
  -e staging \
  --bail

POSTMAN_FOLDERS is a comma-separated list. Each entry becomes one -i (folder name, path, or id).

docker run --rm \
  -e POSTMAN_API_KEY \
  -e POSTMAN_COLLECTION \
  -e POSTMAN_FOLDERS="Auth,Checkout" \
  ghcr.io/rechtlogisch/postman:lts

scripts/run-local clears the entrypoint and runs one command in the container:

scripts/run-local "postman --version"

⁠Environment variables

Report extensions are .xml for junit, .json for json, and .html for html. The default JUnit path is /reports/report.xml. The entrypoint creates the export directory.

-r or --reporters after the image name replaces POSTMAN_REPORTERS. The image then skips the export flags from POSTMAN_REPORT_DIR and POSTMAN_REPORT_BASENAME. A --reporter-<name>-export argument does the same for that one reporter. --reporter-json-structure on the command line is kept as given.

POSTMAN_REPORT_OMIT=all maps to --reporter-<name>-omitAllHeadersAndBody (allHeadersAndBody is the same choice). Any other token stops the run with an error. Omit flags are added for json and html only.

⁠Reporters

• CLI, printed to stdout
• JUnit, written to /reports/report.xml unless POSTMAN_REPORT_DIR or POSTMAN_REPORT_BASENAME is changed
• JSON and HTML, included when named in POSTMAN_REPORTERS

⁠Build

make builds ghcr.io/rechtlogisch/postman:lts. It pulls a fresh base image and passes TAG as the Node.js tag (node:${TAG}-slim).

make

TAG is typically {major-version}, or lts. IMAGE sets the repository name.

make TAG=24
make IMAGE=rechtlogisch/postman

⁠Contributing

Please see CONTRIBUTING⁠ for details.

⁠Security Vulnerabilities

Please review our security policy⁠ on how to report security vulnerabilities.

⁠Credits

• Krzysztof Tomasz Zembrowski⁠
• All Contributors⁠

⁠License

The MIT License (MIT). Please see License File⁠ for more information.