@postman-cse/onboarding-bootstrap 2.9.4 → 2.9.6
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 +11 -2
- package/action.yml +26 -2
- package/dist/action.cjs +1336 -1311
- package/dist/cli.cjs +1359 -1319
- package/dist/index.cjs +1353 -1313
- package/package.json +5 -3
package/README.md
CHANGED
|
@@ -185,6 +185,7 @@ See [Team Identity](docs/team-identity.md) for sub-team discovery and team-ID de
|
|
|
185
185
|
| `protocol` | API spec protocol. auto (default) detects from content/extension. openapi flows through Spec Hub; graphql (SDL/introspection), grpc (.proto), and soap (WSDL) build and instrument a Postman collection directly. | no | `auto` |
|
|
186
186
|
| `protocol-endpoint-url` | Endpoint URL/authority used by generated non-OpenAPI requests (e.g. {{baseUrl}}/graphql, grpc://host:port). Supports Postman variable interpolation. Ignored for openapi. | no | |
|
|
187
187
|
| `openapi-version` | OpenAPI specification version override (3.0 or 3.1). When not set, the version is auto-detected from the spec content. | no | |
|
|
188
|
+
| `preserve-oas30-type-null` | Opt-in compatibility mode for OpenAPI 3.0 oneOf schemas that pair one normal schema with a null-only member. The action uploads the original source bytes unchanged and uses an internal nullable true view for validation and generated artifacts. All unrelated validation and lint errors remain enforced. | no | `false` |
|
|
188
189
|
| `breaking-change-mode` | OpenAPI breaking-change comparison mode (off, pr-native, baseline-only, or previous-spec) | no | `off` |
|
|
189
190
|
| `breaking-baseline-spec-path` | Workspace-relative baseline OpenAPI spec path used by baseline-only mode and pr-native fallback | no | |
|
|
190
191
|
| `breaking-rules-path` | Workspace-relative openapi-changes rules file. Missing files are ignored. | no | `changes-rules.yaml` |
|
|
@@ -194,9 +195,12 @@ See [Team Identity](docs/team-identity.md) for sub-team discovery and team-ID de
|
|
|
194
195
|
| `governance-mapping-json` | Legacy JSON map of business domain to governance group name. Prefer governance-group or the postman-governance-group repository custom property. | no | `{}` |
|
|
195
196
|
| `github-token` | GitHub token used to read the postman-governance-group repository custom property | no | |
|
|
196
197
|
| `gh-fallback-token` | Fallback GitHub token used to read repository custom properties when github-token cannot | no | |
|
|
197
|
-
| `postman-api-key` | Postman service-account API key (PMAK). With a postman-access-token present, the PMAK is used ONLY to mint/re-mint the access token and to log in the Postman CLI for `spec lint` — never for an asset operation. When the key is absent, the CLI spec lint is skipped (governance errors are not enforced). Optional. | no | |
|
|
198
|
-
| `postman-access-token` | Postman service-account access token (x-access-token). Primary credential — every asset operation (workspace create/visibility, spec upload/update, collection generation/read/mutation, test injection, tagging, team-scope) runs through the access-token gateway. Mint it with postman-resolve-service-token-action. Optional only for legacy PMAK-only runs; supply it for the gateway path. | no | |
|
|
198
|
+
| `postman-api-key` | Postman service-account API key (PMAK). With a postman-access-token present, the PMAK is used ONLY to mint/re-mint the access token and to log in the Postman CLI for `spec lint` — never for an asset operation. When the key is absent, the CLI spec lint is skipped (governance errors are not enforced). CLI/binary usage may instead set the POSTMAN_API_KEY environment variable. Optional. | no | |
|
|
199
|
+
| `postman-access-token` | Postman service-account access token (x-access-token). Primary credential — every asset operation (workspace create/visibility, spec upload/update, collection generation/read/mutation, test injection, tagging, team-scope) runs through the access-token gateway. Mint it with postman-resolve-service-token-action. CLI/binary usage may instead set the POSTMAN_ACCESS_TOKEN environment variable (e.g. Jenkins withCredentials). Optional only for legacy PMAK-only runs; supply it for the gateway path. | no | |
|
|
199
200
|
| `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. | no | `warn` |
|
|
201
|
+
| `branch-strategy` | Branch-aware sync strategy. legacy (default) keeps branch-blind behavior; publish-gate restricts canonical writes to the canonical branch and runs credential-free static validation on other branches; preview additionally maintains suffixed per-branch preview asset sets. | no | `legacy` |
|
|
202
|
+
| `canonical-branch` | Explicit canonical branch (the sole writer of canonical assets). Defaults to the provider-resolved default branch; required on providers without a default-branch variable (Bitbucket, Azure DevOps) when branch-strategy is not legacy. | no | |
|
|
203
|
+
| `channels` | Comma-separated channel map for long-lived promotion branches, e.g. "develop=DEV, staging=STAGE, release/*=RC". Channel branches maintain prefix-named parallel asset sets and never mutate canonical assets. | no | |
|
|
200
204
|
| `folder-strategy` | Folder organization strategy for generated collections (Paths or Tags) | no | `Paths` |
|
|
201
205
|
| `nested-folder-hierarchy` | When folder-strategy is Tags, enables nested folder hierarchy | no | `false` |
|
|
202
206
|
| `request-name-source` | Determines how requests are named in generated collections (Fallback or URL) | no | `Fallback` |
|
|
@@ -219,6 +223,11 @@ See [Team Identity](docs/team-identity.md) for sub-team discovery and team-ID de
|
|
|
219
223
|
| `lint-summary-json` | JSON summary of lint errors and warnings. When postman-api-key is absent the CLI lint is skipped and this is { status: "skipped", reason: "no postman-api-key" }. | n/a | n/a |
|
|
220
224
|
| `breaking-change-status` | OpenAPI breaking-change check status | n/a | n/a |
|
|
221
225
|
| `breaking-change-summary-json` | JSON summary of the OpenAPI breaking-change check | n/a | n/a |
|
|
226
|
+
| `sync-status` | Branch-aware sync status: synced, skipped-branch-gate, or empty under branch-strategy legacy. | n/a | n/a |
|
|
227
|
+
| `branch-decision` | Serialized BranchDecision JSON for downstream actions (also exported as POSTMAN_BRANCH_DECISION). | n/a | n/a |
|
|
228
|
+
| `spec-version-tag` | Native Spec Hub version tag applied on this canonical publish (tag-per-publish), empty when tagging was skipped (no-op sync, non-canonical run, or legacy client). | n/a | n/a |
|
|
229
|
+
| `spec-version-url` | Reserved for the repo-sync finalizer; bootstrap does not tag before complete onboarding. | n/a | n/a |
|
|
230
|
+
| `spec-content-changed` | Whether bootstrap changed canonical spec content; repo-sync uses this to skip native version tags on no-op syncs. | n/a | n/a |
|
|
222
231
|
<!-- outputs-table:end -->
|
|
223
232
|
|
|
224
233
|
Regenerate both tables from `action.yml` with `npm run docs:tables`.
|
package/action.yml
CHANGED
|
@@ -81,6 +81,10 @@ inputs:
|
|
|
81
81
|
description: OpenAPI specification version override (3.0 or 3.1). When not set, the version is auto-detected from the spec content.
|
|
82
82
|
required: false
|
|
83
83
|
default: ''
|
|
84
|
+
preserve-oas30-type-null:
|
|
85
|
+
description: 'Opt-in compatibility mode for OpenAPI 3.0 oneOf schemas that pair one normal schema with a null-only member. The action uploads the original source bytes unchanged and uses an internal nullable true view for validation and generated artifacts. All unrelated validation and lint errors remain enforced.'
|
|
86
|
+
required: false
|
|
87
|
+
default: 'false'
|
|
84
88
|
breaking-change-mode:
|
|
85
89
|
description: OpenAPI breaking-change comparison mode (off, pr-native, baseline-only, or previous-spec)
|
|
86
90
|
required: false
|
|
@@ -114,15 +118,25 @@ inputs:
|
|
|
114
118
|
description: Fallback GitHub token used to read repository custom properties when github-token cannot
|
|
115
119
|
required: false
|
|
116
120
|
postman-api-key:
|
|
117
|
-
description: Postman service-account API key (PMAK). With a postman-access-token present, the PMAK is used ONLY to mint/re-mint the access token and to log in the Postman CLI for `spec lint` — never for an asset operation. When the key is absent, the CLI spec lint is skipped (governance errors are not enforced). Optional.
|
|
121
|
+
description: Postman service-account API key (PMAK). With a postman-access-token present, the PMAK is used ONLY to mint/re-mint the access token and to log in the Postman CLI for `spec lint` — never for an asset operation. When the key is absent, the CLI spec lint is skipped (governance errors are not enforced). CLI/binary usage may instead set the POSTMAN_API_KEY environment variable. Optional.
|
|
118
122
|
required: false
|
|
119
123
|
postman-access-token:
|
|
120
|
-
description: Postman service-account access token (x-access-token). Primary credential — every asset operation (workspace create/visibility, spec upload/update, collection generation/read/mutation, test injection, tagging, team-scope) runs through the access-token gateway. Mint it with postman-resolve-service-token-action. Optional only for legacy PMAK-only runs; supply it for the gateway path.
|
|
124
|
+
description: Postman service-account access token (x-access-token). Primary credential — every asset operation (workspace create/visibility, spec upload/update, collection generation/read/mutation, test injection, tagging, team-scope) runs through the access-token gateway. Mint it with postman-resolve-service-token-action. CLI/binary usage may instead set the POSTMAN_ACCESS_TOKEN environment variable (e.g. Jenkins withCredentials). Optional only for legacy PMAK-only runs; supply it for the gateway path.
|
|
121
125
|
required: false
|
|
122
126
|
credential-preflight:
|
|
123
127
|
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."
|
|
124
128
|
required: false
|
|
125
129
|
default: warn
|
|
130
|
+
branch-strategy:
|
|
131
|
+
description: "Branch-aware sync strategy. legacy (default) keeps branch-blind behavior; publish-gate restricts canonical writes to the canonical branch and runs credential-free static validation on other branches; preview additionally maintains suffixed per-branch preview asset sets."
|
|
132
|
+
required: false
|
|
133
|
+
default: legacy
|
|
134
|
+
canonical-branch:
|
|
135
|
+
description: Explicit canonical branch (the sole writer of canonical assets). Defaults to the provider-resolved default branch; required on providers without a default-branch variable (Bitbucket, Azure DevOps) when branch-strategy is not legacy.
|
|
136
|
+
required: false
|
|
137
|
+
channels:
|
|
138
|
+
description: 'Comma-separated channel map for long-lived promotion branches, e.g. "develop=DEV, staging=STAGE, release/*=RC". Channel branches maintain prefix-named parallel asset sets and never mutate canonical assets.'
|
|
139
|
+
required: false
|
|
126
140
|
integration-backend:
|
|
127
141
|
description: Advanced/internal. Integration backend for managed workspace connectivity; leave unset to use the default.
|
|
128
142
|
required: false
|
|
@@ -169,6 +183,16 @@ outputs:
|
|
|
169
183
|
description: OpenAPI breaking-change check status
|
|
170
184
|
breaking-change-summary-json:
|
|
171
185
|
description: JSON summary of the OpenAPI breaking-change check
|
|
186
|
+
sync-status:
|
|
187
|
+
description: "Branch-aware sync status: synced, skipped-branch-gate, or empty under branch-strategy legacy."
|
|
188
|
+
branch-decision:
|
|
189
|
+
description: Serialized BranchDecision JSON for downstream actions (also exported as POSTMAN_BRANCH_DECISION).
|
|
190
|
+
spec-version-tag:
|
|
191
|
+
description: Native Spec Hub version tag applied on this canonical publish (tag-per-publish), empty when tagging was skipped (no-op sync, non-canonical run, or legacy client).
|
|
192
|
+
spec-version-url:
|
|
193
|
+
description: Reserved for the repo-sync finalizer; bootstrap does not tag before complete onboarding.
|
|
194
|
+
spec-content-changed:
|
|
195
|
+
description: Whether bootstrap changed canonical spec content; repo-sync uses this to skip native version tags on no-op syncs.
|
|
172
196
|
runs:
|
|
173
197
|
using: node24
|
|
174
198
|
main: dist/action.cjs
|