@postman-cse/onboarding-repo-sync 1.0.2 → 1.0.4
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 +107 -21
- package/action.yml +18 -11
- package/dist/action.cjs +2748 -2552
- package/dist/cli.cjs +2733 -2537
- package/dist/index.cjs +2748 -2552
- package/package.json +6 -4
package/README.md
CHANGED
|
@@ -1,8 +1,22 @@
|
|
|
1
|
-
# Postman Repo Sync
|
|
1
|
+
# Postman Onboarding: Repo Sync
|
|
2
2
|
|
|
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-cse/onboarding-repo-sync) [](LICENSE)
|
|
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-cse/onboarding-repo-sync) [](LICENSE)
|
|
4
4
|
|
|
5
|
-
Exports Postman collections and environments into your repository and wires CI,
|
|
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
|
+
|
|
7
|
+
Part of the [Postman API Onboarding suite](https://github.com/postman-cs/postman-api-onboarding-action).
|
|
8
|
+
|
|
9
|
+
## Which action should I use?
|
|
10
|
+
|
|
11
|
+
| Need | Use |
|
|
12
|
+
| --- | --- |
|
|
13
|
+
| Run the full onboarding flow from one workflow step | [Postman API Onboarding](https://github.com/postman-cs/postman-api-onboarding-action) |
|
|
14
|
+
| Mint a fresh service-account access token and team ID | [Postman Onboarding: Service Token](https://github.com/postman-cs/postman-resolve-service-token-action) |
|
|
15
|
+
| Create a workspace, upload an OpenAPI spec, and generate collections | [Postman Onboarding: Workspace Bootstrap](https://github.com/postman-cs/postman-bootstrap-action) |
|
|
16
|
+
| Export workspace artifacts into the repository and wire CI, mocks, and monitors | This action |
|
|
17
|
+
| Discover OpenAPI specs from AWS services | [Postman Onboarding: AWS Spec Discovery](https://github.com/postman-cs/postman-aws-spec-discovery-action) |
|
|
18
|
+
| Apply the curated smoke-test flow to an existing Smoke collection | [Postman Onboarding: Smoke Flow](https://github.com/postman-cs/postman-smoke-flow-action) |
|
|
19
|
+
| Link Postman Insights services to an onboarding workspace | [Postman Onboarding: Insights Linking](https://github.com/postman-cs/postman-insights-onboarding-action) |
|
|
6
20
|
|
|
7
21
|
## Usage
|
|
8
22
|
|
|
@@ -16,14 +30,27 @@ jobs:
|
|
|
16
30
|
steps:
|
|
17
31
|
- uses: actions/checkout@v5
|
|
18
32
|
|
|
33
|
+
- id: postman-auth
|
|
34
|
+
uses: postman-cs/postman-resolve-service-token-action@v1
|
|
35
|
+
with:
|
|
36
|
+
postman-region: us
|
|
37
|
+
postman-api-key: ${{ secrets.POSTMAN_API_KEY }}
|
|
38
|
+
|
|
19
39
|
- uses: postman-cs/postman-repo-sync-action@v1
|
|
20
40
|
with:
|
|
21
41
|
project-name: core-payments
|
|
42
|
+
postman-region: us
|
|
22
43
|
postman-api-key: ${{ secrets.POSTMAN_API_KEY }}
|
|
44
|
+
postman-access-token: ${{ steps.postman-auth.outputs.token }}
|
|
45
|
+
team-id: ${{ steps.postman-auth.outputs.team-id }}
|
|
23
46
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
|
24
47
|
```
|
|
25
48
|
|
|
26
|
-
`actions/checkout` must run before this action. `project-name` is the only required input
|
|
49
|
+
`actions/checkout` must run before this action. `project-name` is the only schema-required input. A useful sync also needs a Postman API key or a service-token step that can mint one, plus workspace and collection IDs from inputs or `.postman/resources.yaml`.
|
|
50
|
+
|
|
51
|
+
The example permissions let `GITHUB_TOKEN` commit generated artifacts and update the generated workflow file. `contents: write` is required for `repo-write-mode: commit-only` and `commit-and-push`. `actions: write` is required when `generate-ci-workflow` writes under `.github/workflows/`. Repository secret persistence, such as a generated `POSTMAN_API_KEY` or mTLS certificate secret, needs `gh-fallback-token` with permission to manage Actions secrets.
|
|
52
|
+
|
|
53
|
+
`postman-region` controls the Postman public API host and generated [Postman CLI login region](https://learning.postman.com/docs/postman-cli/postman-cli-auth/). Use `us` for `https://api.getpostman.com` and `eu` for `https://api.eu.postman.com` when the team uses [EU data residency](https://learning.postman.com/docs/administration/enterprise/about-eu-data-residency/).
|
|
27
54
|
|
|
28
55
|
## Examples
|
|
29
56
|
|
|
@@ -37,14 +64,16 @@ jobs:
|
|
|
37
64
|
baseline-collection-id: col-baseline
|
|
38
65
|
smoke-collection-id: col-smoke
|
|
39
66
|
contract-collection-id: col-contract
|
|
67
|
+
postman-region: us
|
|
40
68
|
environments-json: '["prod","stage"]'
|
|
41
69
|
env-runtime-urls-json: '{"prod":"https://api.example.com","stage":"https://stage-api.example.com"}'
|
|
42
70
|
postman-api-key: ${{ secrets.POSTMAN_API_KEY }}
|
|
43
|
-
postman-access-token: ${{
|
|
71
|
+
postman-access-token: ${{ steps.postman-auth.outputs.token }}
|
|
72
|
+
team-id: ${{ steps.postman-auth.outputs.team-id }}
|
|
44
73
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
|
45
74
|
```
|
|
46
75
|
|
|
47
|
-
`postman-access-token` is required for workspace-to-repository linking, system environment association, and API key generation. If it is omitted, those integration steps are skipped and the remaining artifact sync can still run with `postman-api-key`. See [docs/credentials.md](docs/credentials.md).
|
|
76
|
+
`postman-access-token` is required for workspace-to-repository linking, system environment association, and API key generation. Use `postman-resolve-service-token-action` to mint it at runtime from a [Postman service account](https://learning.postman.com/docs/administration/service-accounts/) PMAK. If it is omitted, those integration steps are skipped and the remaining artifact sync can still run with `postman-api-key`. See [docs/credentials.md](docs/credentials.md).
|
|
48
77
|
|
|
49
78
|
### Disable CI workflow generation
|
|
50
79
|
|
|
@@ -83,7 +112,7 @@ with:
|
|
|
83
112
|
|
|
84
113
|
### Reuse an existing mock server and monitor
|
|
85
114
|
|
|
86
|
-
Pass `mock-url` or `monitor-id` to validate and reuse existing
|
|
115
|
+
Pass `mock-url` or `monitor-id` to validate and reuse existing [mock servers](https://learning.postman.com/docs/design-apis/mock-apis/set-up-mock-servers/) or [monitors](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/) instead of creating new ones:
|
|
87
116
|
|
|
88
117
|
```yaml
|
|
89
118
|
with:
|
|
@@ -93,7 +122,7 @@ with:
|
|
|
93
122
|
|
|
94
123
|
### mTLS certificates for Postman CLI runs
|
|
95
124
|
|
|
96
|
-
The generated CI workflow can run Postman CLI with client certificates. Pass the cert material as inputs; when a GitHub token and repository context are available, the action persists them as repository secrets (`POSTMAN_SSL_CLIENT_CERT_B64`, `POSTMAN_SSL_CLIENT_KEY_B64`, `POSTMAN_SSL_CLIENT_PASSPHRASE`, `POSTMAN_SSL_EXTRA_CA_CERTS_B64`) for the generated workflow:
|
|
125
|
+
The generated CI workflow can run [Postman CLI collection runs](https://learning.postman.com/docs/postman-cli/postman-cli-collections/) with client certificates. Pass the cert material as inputs; when a GitHub token and repository context are available, the action persists them as repository secrets (`POSTMAN_SSL_CLIENT_CERT_B64`, `POSTMAN_SSL_CLIENT_KEY_B64`, `POSTMAN_SSL_CLIENT_PASSPHRASE`, `POSTMAN_SSL_EXTRA_CA_CERTS_B64`) for the generated workflow:
|
|
97
126
|
|
|
98
127
|
```yaml
|
|
99
128
|
with:
|
|
@@ -123,7 +152,6 @@ with:
|
|
|
123
152
|
| `monitor-cron` | Cron expression for monitor scheduling (e.g. '0 */6 * * *'). When empty, the monitor is created disabled and triggered to run once per workflow invocation (and once on every subsequent run). | no | `""` |
|
|
124
153
|
| `environments-json` | JSON array of environment slugs to create or update. | no | `["prod"]` |
|
|
125
154
|
| `repo-url` | Explicit repository URL (GitHub or GitLab). Defaults to https://github.com/$GITHUB_REPOSITORY on GitHub Actions, or $CI_PROJECT_URL on GitLab CI, when omitted. | no | |
|
|
126
|
-
| `integration-backend` | Integration backend for workspace linking and environment sync. | no | `bifrost` |
|
|
127
155
|
| `workspace-link-enabled` | Enable workspace linking. | no | `true` |
|
|
128
156
|
| `environment-sync-enabled` | Enable association of Postman environments to system environments. | no | `true` |
|
|
129
157
|
| `system-env-map-json` | JSON map of environment slug to system environment id. | no | `{}` |
|
|
@@ -132,14 +160,15 @@ with:
|
|
|
132
160
|
| `artifact-dir` | Root directory for exported Postman artifacts. | no | `postman` |
|
|
133
161
|
| `repo-write-mode` | Repo mutation mode for generated artifacts and workflow files. | no | `commit-and-push` |
|
|
134
162
|
| `current-ref` | Explicit ref override for push-changes when the checkout is detached. | no | |
|
|
135
|
-
| `committer-name` | Git committer name for sync commits. | no | `Postman
|
|
136
|
-
| `committer-email` | Git committer email for sync commits. | no | `
|
|
163
|
+
| `committer-name` | Git committer name for sync commits. | no | `Postman` |
|
|
164
|
+
| `committer-email` | Git committer email for sync commits. | no | `support@postman.com` |
|
|
137
165
|
| `postman-api-key` | Postman API key used for environment, mock, and monitor operations. | no | |
|
|
138
|
-
| `postman-access-token` | Postman access token used for
|
|
139
|
-
| `
|
|
166
|
+
| `postman-access-token` | Postman access token used for workspace linking, system environment association, and generated API-key creation. | no | |
|
|
167
|
+
| `team-id` | Postman team ID resolved by postman-resolve-service-token-action for org-mode integration calls. Falls back to POSTMAN_TEAM_ID when omitted. | no | `""` |
|
|
168
|
+
| `credential-preflight` | Credential identity preflight policy. warn (default) logs a note and continues when postman-api-key and postman-access-token resolve to different parent orgs; enforce fails the run on that condition before any workspace is created. Both modes warn when postman-access-token is not a service-account token. | no | `warn` |
|
|
140
169
|
| `github-token` | GitHub token used for repo variable persistence and commits. | no | |
|
|
141
170
|
| `gh-fallback-token` | Fallback token for repository variable APIs and workflow-file pushes. | no | |
|
|
142
|
-
| `org-mode` | Whether the Postman team uses org-mode. When true, x-entity-team-id
|
|
171
|
+
| `org-mode` | Whether the Postman team uses org-mode. When true, x-entity-team-id is included in Postman integration API calls. Non-org teams must omit this header. | no | `false` |
|
|
143
172
|
| `ci-workflow-base64` | Optional base64-encoded ci.yml content. Defaults to the built-in template. | no | |
|
|
144
173
|
| `ssl-client-cert` | Base64-encoded PEM client certificate for Postman CLI mTLS runs. | no | |
|
|
145
174
|
| `ssl-client-key` | Base64-encoded PEM client private key for Postman CLI mTLS runs. | no | |
|
|
@@ -147,7 +176,7 @@ with:
|
|
|
147
176
|
| `ssl-extra-ca-certs` | Optional base64-encoded PEM CA certificate bundle for custom trust. | no | |
|
|
148
177
|
| `spec-id` | Spec UID from bootstrap, persisted into .postman/resources.yaml cloudResources. | no | |
|
|
149
178
|
| `spec-path` | Optional repo-root-relative path to the local spec file for resources/workflows metadata. | no | |
|
|
150
|
-
| `postman-
|
|
179
|
+
| `postman-region` | Postman data residency region for public API and Postman CLI calls. One of: us or eu. | no | `us` |
|
|
151
180
|
<!-- inputs-table:end -->
|
|
152
181
|
|
|
153
182
|
## Outputs
|
|
@@ -155,7 +184,6 @@ with:
|
|
|
155
184
|
<!-- outputs-table:start -->
|
|
156
185
|
| Name | Description |
|
|
157
186
|
| --- | --- |
|
|
158
|
-
| `integration-backend` | Resolved integration backend for the customer preview run. |
|
|
159
187
|
| `resolved-current-ref` | Resolved push target based on current-ref semantics. |
|
|
160
188
|
| `workspace-link-status` | Whether workspace linking succeeded, was skipped, or failed. |
|
|
161
189
|
| `environment-sync-status` | Whether environment sync succeeded, was skipped, or failed. |
|
|
@@ -170,16 +198,22 @@ with:
|
|
|
170
198
|
|
|
171
199
|
The action syncs a Postman workspace into the checked-out repository and can connect the workspace back to that repository:
|
|
172
200
|
|
|
173
|
-
- Postman Collection v3 multi-file YAML exports under `postman/collections/`.
|
|
174
|
-
- Postman environment exports under `postman/environments/`.
|
|
201
|
+
- [Postman Collection v3](https://learning.postman.com/docs/use/use-collections/collections-schemas/) multi-file YAML exports under `postman/collections/`.
|
|
202
|
+
- [Postman environment](https://learning.postman.com/docs/use/send-requests/variables/managing-environments/) exports under `postman/environments/`.
|
|
175
203
|
- `.postman/resources.yaml` with local-to-cloud resource mappings.
|
|
176
204
|
- Optional `.postman/workflows.yaml` spec-to-collection metadata.
|
|
177
|
-
- Optional generated GitHub Actions workflow for Postman CLI smoke and contract runs.
|
|
205
|
+
- Optional generated GitHub Actions workflow for [Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-run-collection/) smoke and contract runs.
|
|
178
206
|
- Optional mock server, cloud monitor, workspace repository link, and system environment associations.
|
|
179
207
|
|
|
208
|
+
The generated files are intended to be committed when `repo-write-mode` is `commit-only` or `commit-and-push`. Treat `postman/` and `.postman/` as reviewable source artifacts for the onboarding workflow; commit and review them like any other tracked source.
|
|
209
|
+
|
|
180
210
|
A typical export looks like:
|
|
181
211
|
|
|
182
212
|
```text
|
|
213
|
+
postman/collections/core-payments/
|
|
214
|
+
collection.yaml
|
|
215
|
+
<folder>.yaml
|
|
216
|
+
<request>.yaml
|
|
183
217
|
postman/collections/[Smoke] core-payments/
|
|
184
218
|
collection.yaml
|
|
185
219
|
<folder>.yaml
|
|
@@ -199,9 +233,24 @@ Deeper reference:
|
|
|
199
233
|
- [Artifact layout and Collection v3 format](docs/artifact-layout.md), including sync modes and versioned releases.
|
|
200
234
|
- [Credentials](docs/credentials.md): `postman-api-key`, `postman-access-token`, credential preflight, GitHub tokens.
|
|
201
235
|
- [CLI usage](docs/cli.md): the `postman-repo-sync` binary for GitLab CI, Bitbucket Pipelines, and Azure DevOps.
|
|
236
|
+
- [Security](SECURITY.md): supported releases, reporting, and secret-handling expectations.
|
|
237
|
+
- [Support](SUPPORT.md): where to ask usage questions and what diagnostics to include.
|
|
238
|
+
- [Release policy](RELEASE_POLICY.md): immutable version tags and the rolling `v1` alias.
|
|
202
239
|
|
|
203
240
|
## Resources
|
|
204
241
|
|
|
242
|
+
### The suite
|
|
243
|
+
|
|
244
|
+
| Action | Role |
|
|
245
|
+
| --- | --- |
|
|
246
|
+
| [Postman API Onboarding](https://github.com/postman-cs/postman-api-onboarding-action) | Entry point: chains workspace bootstrap, repo sync, and optional Insights linking |
|
|
247
|
+
| [Postman Onboarding: Service Token](https://github.com/postman-cs/postman-resolve-service-token-action) | Mints the service-account access token and team ID |
|
|
248
|
+
| [Postman Onboarding: AWS Spec Discovery](https://github.com/postman-cs/postman-aws-spec-discovery-action) | Discovers and exports API specs from AWS services |
|
|
249
|
+
| [Postman Onboarding: Workspace Bootstrap](https://github.com/postman-cs/postman-bootstrap-action) | Creates the workspace, uploads the spec, generates collections |
|
|
250
|
+
| [Postman Onboarding: Smoke Flow](https://github.com/postman-cs/postman-smoke-flow-action) | Applies a curated flow.yaml to the Smoke collection |
|
|
251
|
+
| [Postman Onboarding: Repo Sync](https://github.com/postman-cs/postman-repo-sync-action) | Exports artifacts into the repo and wires CI, mocks, and monitors |
|
|
252
|
+
| [Postman Onboarding: Insights Linking](https://github.com/postman-cs/postman-insights-onboarding-action) | Links Insights discovered services to the workspace |
|
|
253
|
+
|
|
205
254
|
- [postman-resolve-service-token-action](https://github.com/postman-cs/postman-resolve-service-token-action): mints a service-account access token and team ID.
|
|
206
255
|
- [postman-api-onboarding-action](https://github.com/postman-cs/postman-api-onboarding-action): composite action that orchestrates the onboarding pipeline.
|
|
207
256
|
- [postman-bootstrap-action](https://github.com/postman-cs/postman-bootstrap-action): workspace provisioning, spec upload, and collection generation.
|
|
@@ -209,8 +258,45 @@ Deeper reference:
|
|
|
209
258
|
- [postman-insights-onboarding-action](https://github.com/postman-cs/postman-insights-onboarding-action): links Postman Insights to a workspace.
|
|
210
259
|
- [postman-aws-spec-discovery-action](https://github.com/postman-cs/postman-aws-spec-discovery-action): discovers API specs in AWS accounts.
|
|
211
260
|
- npm package: [@postman-cse/onboarding-repo-sync](https://www.npmjs.com/package/@postman-cse/onboarding-repo-sync)
|
|
212
|
-
- [Postman API
|
|
213
|
-
- [Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-
|
|
261
|
+
- Postman API and auth references: [Postman API](https://learning.postman.com/docs/reference/postman-api/intro-api/), [API authentication](https://learning.postman.com/docs/reference/postman-api/authentication/), [Postman CLI auth](https://learning.postman.com/docs/postman-cli/postman-cli-auth/), [EU data residency](https://learning.postman.com/docs/administration/enterprise/about-eu-data-residency/)
|
|
262
|
+
- Postman artifact and runtime references: [Collection v3 schema](https://learning.postman.com/docs/use/use-collections/collections-schemas/), [Postman CLI collection runs](https://learning.postman.com/docs/postman-cli/postman-cli-run-collection/), [environments](https://learning.postman.com/docs/use/send-requests/variables/managing-environments/), [mock servers](https://learning.postman.com/docs/design-apis/mock-apis/set-up-mock-servers/), [monitors](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/)
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
## Telemetry
|
|
266
|
+
|
|
267
|
+
This action sends a single non-identifying usage event when a run completes, so the
|
|
268
|
+
Postman team can measure adoption across CI systems. The event contains the
|
|
269
|
+
action name and version, your Postman team ID, the detected CI provider and
|
|
270
|
+
runner kind, the run outcome, the CI run identifier, an event timestamp, and a one-way SHA-256 hash of the repository
|
|
271
|
+
identifier. Each event also carries a schema version and a constant event marker (always `completion`). The Postman team ID is sent in the clear on a legitimate-interest
|
|
272
|
+
basis to measure product adoption.
|
|
273
|
+
|
|
274
|
+
The `events.pm-cse.dev` endpoint is operated by the Postman Customer Success
|
|
275
|
+
Engineering team. Postman, Inc. processes these events only to measure
|
|
276
|
+
onboarding adoption in aggregate, retains them only as aggregated counts for
|
|
277
|
+
product-adoption trend analysis, and includes no payload field that identifies
|
|
278
|
+
an individual person.
|
|
279
|
+
|
|
280
|
+
It never sends API keys, access tokens, spec content, workspace or repository
|
|
281
|
+
names, or any personal data. It is fire-and-forget with a hard
|
|
282
|
+
timeout and can never block or fail your pipeline. Corporate HTTP and HTTPS
|
|
283
|
+
proxies are honored through the standard `HTTPS_PROXY`, `HTTP_PROXY`, and
|
|
284
|
+
`NO_PROXY` environment variables.
|
|
285
|
+
|
|
286
|
+
Disable it by setting either environment variable in your CI:
|
|
287
|
+
|
|
288
|
+
```sh
|
|
289
|
+
POSTMAN_ACTIONS_TELEMETRY=off
|
|
290
|
+
# or the cross-tool standard
|
|
291
|
+
DO_NOT_TRACK=1
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
Telemetry is also skipped automatically when no Postman team ID can be resolved.
|
|
295
|
+
|
|
296
|
+
Events are sent over HTTPS to `https://events.pm-cse.dev/v1/events`. To
|
|
297
|
+
allowlist this destination on a restricted network, or to route events to a
|
|
298
|
+
collector you operate, set the `POSTMAN_ACTIONS_TELEMETRY_ENDPOINT` environment
|
|
299
|
+
variable to your own URL.
|
|
214
300
|
|
|
215
301
|
## License
|
|
216
302
|
|
package/action.yml
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
name: Postman Repo Sync
|
|
2
|
-
description: Export Postman collections and environments into your repo
|
|
1
|
+
name: 'Postman Onboarding: Repo Sync'
|
|
2
|
+
description: Export Postman collections and environments into your repo with CI wiring. Part of the Postman API Onboarding suite.
|
|
3
3
|
author: Postman
|
|
4
4
|
branding:
|
|
5
5
|
icon: refresh-cw
|
|
@@ -62,9 +62,8 @@ inputs:
|
|
|
62
62
|
description: 'Explicit repository URL (GitHub or GitLab). Defaults to https://github.com/$GITHUB_REPOSITORY on GitHub Actions, or $CI_PROJECT_URL on GitLab CI, when omitted.'
|
|
63
63
|
required: false
|
|
64
64
|
integration-backend:
|
|
65
|
-
description: Integration backend for workspace linking and environment sync.
|
|
65
|
+
description: Advanced/internal. Integration backend for managed workspace linking and environment sync; leave unset to use the default.
|
|
66
66
|
required: false
|
|
67
|
-
default: bifrost
|
|
68
67
|
workspace-link-enabled:
|
|
69
68
|
description: Enable workspace linking.
|
|
70
69
|
required: false
|
|
@@ -99,19 +98,23 @@ inputs:
|
|
|
99
98
|
committer-name:
|
|
100
99
|
description: Git committer name for sync commits.
|
|
101
100
|
required: false
|
|
102
|
-
default: Postman
|
|
101
|
+
default: Postman
|
|
103
102
|
committer-email:
|
|
104
103
|
description: Git committer email for sync commits.
|
|
105
104
|
required: false
|
|
106
|
-
default:
|
|
105
|
+
default: support@postman.com
|
|
107
106
|
postman-api-key:
|
|
108
107
|
description: Postman API key used for environment, mock, and monitor operations.
|
|
109
108
|
required: false
|
|
110
109
|
postman-access-token:
|
|
111
|
-
description: Postman access token used for
|
|
110
|
+
description: Postman access token used for workspace linking, system environment association, and generated API-key creation.
|
|
112
111
|
required: false
|
|
112
|
+
team-id:
|
|
113
|
+
description: Postman team ID resolved by postman-resolve-service-token-action for org-mode integration calls. Falls back to POSTMAN_TEAM_ID when omitted.
|
|
114
|
+
required: false
|
|
115
|
+
default: ""
|
|
113
116
|
credential-preflight:
|
|
114
|
-
description: "Credential identity preflight policy. warn (default) logs a note and continues when postman-api-key and postman-access-token resolve to different parent orgs; enforce fails the run on that condition before any workspace is created
|
|
117
|
+
description: "Credential identity preflight policy. warn (default) logs a note and continues when postman-api-key and postman-access-token resolve to different parent orgs; enforce fails the run on that condition before any workspace is created. Both modes warn when postman-access-token is not a service-account token."
|
|
115
118
|
required: false
|
|
116
119
|
default: warn
|
|
117
120
|
github-token:
|
|
@@ -121,7 +124,7 @@ inputs:
|
|
|
121
124
|
description: Fallback token for repository variable APIs and workflow-file pushes.
|
|
122
125
|
required: false
|
|
123
126
|
org-mode:
|
|
124
|
-
description: Whether the Postman team uses org-mode. When true, x-entity-team-id
|
|
127
|
+
description: Whether the Postman team uses org-mode. When true, x-entity-team-id is included in Postman integration API calls. Non-org teams must omit this header.
|
|
125
128
|
required: false
|
|
126
129
|
default: 'false'
|
|
127
130
|
ci-workflow-base64:
|
|
@@ -145,13 +148,17 @@ inputs:
|
|
|
145
148
|
spec-path:
|
|
146
149
|
description: Optional repo-root-relative path to the local spec file for resources/workflows metadata.
|
|
147
150
|
required: false
|
|
151
|
+
postman-region:
|
|
152
|
+
description: "Postman data residency region for public API and Postman CLI calls. One of: us or eu."
|
|
153
|
+
required: false
|
|
154
|
+
default: us
|
|
148
155
|
postman-stack:
|
|
149
|
-
description: Postman stack profile.
|
|
156
|
+
description: 'Postman stack profile. Leave at the default unless Postman support directs otherwise.'
|
|
150
157
|
required: false
|
|
151
158
|
default: prod
|
|
152
159
|
outputs:
|
|
153
160
|
integration-backend:
|
|
154
|
-
description: Resolved integration backend for the
|
|
161
|
+
description: Resolved integration backend for the onboarding run.
|
|
155
162
|
resolved-current-ref:
|
|
156
163
|
description: Resolved push target based on current-ref semantics.
|
|
157
164
|
workspace-link-status:
|