Skip to content

Integrate Postman Collections and Environments from File System - #74

Open
JackyZhaoPostman wants to merge 1 commit into
developfrom
feature/postman-integration
Open

JackyZhaoPostman wants to merge 1 commit into
developfrom
feature/postman-integration

Conversation

@JackyZhaoPostman

Copy link
Copy Markdown
Collaborator

Summary

This PR sets up integration between this repository and the linked Postman workspace.

The following assets are introduced:

  • postman/ — Contains exported contents of the linked Postman workspace (collections, environments, APIs, etc.)
  • .config/ — Stores workspace configuration required for synchronization
  • .github/workflows/postman-publish.yaml — GitHub Actions workflow to keep repository files in sync with Postman Cloud

What this enables

The .github/workflows/postman-publish.yaml GitHub Actions workflow ensures that changes made locally to the Postman files are automatically synchronized with the linked Postman workspace in Postman Cloud.

This establishes this repository as the source of truth while keeping the Postman workspace continuously up to date.

Required one-time setup (before merging)

To ensure the GitHub Actions workflow works correctly, the repository owner must complete the following step before merging this PR.

Add required secret

Where to add it:
GitHub → Repository Settings → Secrets and variables → Actions

Add POSTMAN_API_KEY as a repository secret. You can generate a Postman API key from Postman → Settings → API Keys.

⚠️ The .github/workflows/postman-publish.yaml GitHub Actions workflow will fail if POSTMAN_API_KEY is not configured.

Files introduced in this PR

  • postman/
  • .config/
  • .github/workflows/postman-publish.yaml

Why you're seeing this PR

This PR is created automatically to link this repository with its corresponding Postman workspace and enable continuous synchronization.

Checklist

  • Added POSTMAN_API_KEY secret
  • Verified the GitHub Actions workflow runs successfully after merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant