This feature has been deprecated and it’s no longer possible to create a new connection between a GitHub repo and a collection. Existing connections between repos and collections will continue to sync.
You can work on your API project files locally in Postman with Postman’s file system (Native Git) support. Learn more about Postman’s Native Git support here
Connect a GitHub repository and branch to your collection and collaborate with your team on your collection’s releases. For example, connect your repository’s primary branch to your collection, fork that collection in Postman, and collaborate with your team on your collection’s next release.
Connect a GitHub repository and branch to your collection
Before you get started, create your repository and primary branch.
To connect a GitHub repository and branch to your collection, do the following:
-
Open your collection.
-
Next to your collection, click
View more actions. Then, click More > Connect repository. -
Choose where you host your repository:
- If you choose GitHub, Postman asks you to authenticate. Follow the onscreen instructions.
- If you choose GitHub Enterprise Server, Postman asks you for your GitHub domain. Enter or select it, and click Authenticate. Then, follow the onscreen instructions.
-
Select an organization.
-
If you don’t see your organization, you may need to install the GitHub App to your organization first. To get started, follow the onscreen instructions.
-
Select a repository and branch.
-
(Optional) Enter a directory path for your collection file.
-
Click Connect.
Postman creates a collection file in the connected repository and branch. The collection’s file name is the collection ID. Each time you save your collection in Postman, your changes are committed to the connected GitHub repository and branch.
To start collaborating on your next release, see Collaborate on your collection’s release.
Disconnect a GitHub repository and branch from your collection
If you want to connect a different repository or branch to your collection, or need to troubleshoot your connection, you can start by disconnecting GitHub from your collection.
To disconnect a GitHub repository and branch from your collection, do the following:
- Open your collection.
- Next to your collection, click View more actions. Then, click More > Disconnect repository.
- Enter your collection’s name. Then, click Disconnect repository.
Your collection is no longer connected to the GitHub repository and branch.