@postman-cs/onboarding-repo-sync 2.11.1 → 2.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/action.yml +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Postman
|
|
1
|
+
# Postman Enterprise Automation: Repo Sync
|
|
2
2
|
|
|
3
3
|
[](https://github.com/postman-cs/postman-repo-sync-action/actions/workflows/ci.yml) [](https://github.com/postman-cs/postman-repo-sync-action/releases) [](https://www.npmjs.com/package/@postman-cs/onboarding-repo-sync) [](LICENSE)
|
|
4
4
|
|
|
5
5
|
Exports Postman [collections](https://learning.postman.com/docs/use/use-collections/collections-schemas/) and [environments](https://learning.postman.com/docs/use/send-requests/variables/managing-environments/) into your repository and wires CI, [mock servers](https://learning.postman.com/docs/design-apis/mock-apis/set-up-mock-servers/), and [monitors](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/) around them.
|
|
6
6
|
|
|
7
|
-
Part of the [Postman
|
|
7
|
+
Part of the [Postman Enterprise Automation Suite](https://github.com/postman-cs/postman-api-onboarding-action); the composite action's README has the full action-picker table.
|
|
8
8
|
|
|
9
9
|
- [Usage](#usage)
|
|
10
10
|
- [Examples](#examples)
|
|
@@ -201,7 +201,7 @@ with:
|
|
|
201
201
|
| `current-ref` | Explicit ref override for push-changes when the checkout is detached. | no | |
|
|
202
202
|
| `committer-name` | Git committer name for sync commits. | no | `Postman` |
|
|
203
203
|
| `committer-email` | Git committer email for sync commits. | no | `support@postman.com` |
|
|
204
|
-
| `postman-api-key` | Postman API key (PMAK). Used only to mint/re-mint the access token (via postman-resolve-service-token-action) and for the Postman CLI
|
|
204
|
+
| `postman-api-key` | Postman API key (PMAK). Used only to mint/re-mint the access token (via postman-resolve-service-token-action) and for the Postman CLI login --with-api-key step in the generated CI workflow (collection run). Asset operations (environments, collections, mocks, monitors) run on the access-token gateway and do not use the PMAK. Optional when a valid postman-access-token is supplied (a failing key is replaced by one minted from the token); required as the mint source when postman-access-token is omitted. | no | |
|
|
205
205
|
| `postman-access-token` | Postman access token minted by postman-resolve-service-token-action. Required for all asset operations (environment create/get/update, collection read, mock, monitor) which run through the access-token gateway. Also used for workspace linking, system environment association, and generated API-key creation. When omitted, the action mints one from postman-api-key (service-account PMAK); if that mint also fails the action fails fast — PMAK is never an asset-routing fallback. | no | |
|
|
206
206
|
| `team-id` | Postman team ID resolved by postman-resolve-service-token-action. Primary team scope for all downstream actions; included as x-entity-team-id in org-mode Bifrost calls. Falls back to POSTMAN_TEAM_ID when omitted. Set explicitly for org-mode teams. | no | `""` |
|
|
207
207
|
| `secrets-resolver` | Cloud secret store the generated environments seed credential slots for: none (default, no secret-store variables are added), aws (AWS Secrets Manager), azure (Azure Key Vault), or gcp (Google Secret Manager). Must match the secrets-resolver value passed to the bootstrap and smoke-flow actions. | no | `none` |
|
package/action.yml
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
name: 'Postman
|
|
2
|
-
description: Export Postman collections and environments into your repo with CI wiring. Part of the Postman
|
|
1
|
+
name: 'Postman Enterprise Automation: Repo Sync'
|
|
2
|
+
description: Export Postman collections and environments into your repo with CI wiring. Part of the Postman Enterprise Automation Suite.
|
|
3
3
|
author: Postman
|
|
4
4
|
branding:
|
|
5
5
|
icon: refresh-cw
|
|
@@ -131,7 +131,7 @@ inputs:
|
|
|
131
131
|
required: false
|
|
132
132
|
default: support@postman.com
|
|
133
133
|
postman-api-key:
|
|
134
|
-
description: Postman API key (PMAK). Used only to mint/re-mint the access token (via postman-resolve-service-token-action) and for the Postman CLI
|
|
134
|
+
description: Postman API key (PMAK). Used only to mint/re-mint the access token (via postman-resolve-service-token-action) and for the Postman CLI login --with-api-key step in the generated CI workflow (collection run). Asset operations (environments, collections, mocks, monitors) run on the access-token gateway and do not use the PMAK. Optional when a valid postman-access-token is supplied (a failing key is replaced by one minted from the token); required as the mint source when postman-access-token is omitted.
|
|
135
135
|
required: false
|
|
136
136
|
postman-access-token:
|
|
137
137
|
description: Postman access token minted by postman-resolve-service-token-action. Required for all asset operations (environment create/get/update, collection read, mock, monitor) which run through the access-token gateway. Also used for workspace linking, system environment association, and generated API-key creation. When omitted, the action mints one from postman-api-key (service-account PMAK); if that mint also fails the action fails fast — PMAK is never an asset-routing fallback.
|