@postman-cse/onboarding-repo-sync 2.1.5 → 2.1.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 +9 -0
- package/action.yml +27 -1
- package/dist/action.cjs +866 -104
- package/dist/cli.cjs +1322 -108
- package/dist/index.cjs +876 -104
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -161,6 +161,10 @@ with:
|
|
|
161
161
|
| `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 | |
|
|
162
162
|
| `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 | `""` |
|
|
163
163
|
| `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` |
|
|
164
|
+
| `branch-strategy` | Branch-aware sync strategy. legacy (default) keeps branch-blind behavior; publish-gate restricts canonical writes to the canonical branch and skips repo-sync on other branches; preview additionally maintains suffixed per-branch preview asset sets. | no | `legacy` |
|
|
165
|
+
| `canonical-branch` | Explicit canonical branch (the sole writer of canonical assets and tracked state). 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 | |
|
|
166
|
+
| `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 | |
|
|
167
|
+
| `preview-ttl` | Sliding TTL in days for preview asset sets (refreshed on every successful preview sync; the retention contract of last resort when no provider credential is available for branch-existence checks). | no | `30` |
|
|
164
168
|
| `github-token` | GitHub token used for repo variable persistence and commits. | no | |
|
|
165
169
|
| `gh-fallback-token` | Fallback token for repository variable APIs and workflow-file pushes. | no | |
|
|
166
170
|
| `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` |
|
|
@@ -170,6 +174,7 @@ with:
|
|
|
170
174
|
| `ssl-client-passphrase` | Optional passphrase for encrypted ssl-client-key. | no | |
|
|
171
175
|
| `ssl-extra-ca-certs` | Optional base64-encoded PEM CA certificate bundle for custom trust. | no | |
|
|
172
176
|
| `spec-id` | Spec Hub UID emitted by bootstrap's spec-id output. When set, it is persisted into .postman/resources.yaml cloudResources so later runs and the generated CI workflow can resolve the spec without re-discovery. | no | |
|
|
177
|
+
| `spec-content-changed` | Whether bootstrap changed canonical spec content. Native Spec Hub tag publication is skipped on no-op syncs. | no | `true` |
|
|
173
178
|
| `spec-path` | Optional repo-root-relative path to the local OpenAPI file. Recorded in .postman/resources.yaml and .postman/workflows.yaml metadata so the committed artifacts point back at the spec source in this repository; the file itself is not uploaded by this action. | no | |
|
|
174
179
|
| `postman-region` | Postman data residency region for public API and Postman CLI calls. One of: us or eu. | no | `us` |
|
|
175
180
|
<!-- inputs-table:end -->
|
|
@@ -187,6 +192,10 @@ with:
|
|
|
187
192
|
| `monitor-id` | Created or reused smoke monitor ID. |
|
|
188
193
|
| `repo-sync-summary-json` | JSON summary of repo materialization and workspace sync outputs. |
|
|
189
194
|
| `commit-sha` | Commit SHA produced by repo-write-mode, if any. |
|
|
195
|
+
| `sync-status` | Branch-aware sync status: synced, skipped-branch-gate, or empty under branch-strategy legacy. |
|
|
196
|
+
| `branch-decision` | Serialized BranchDecision JSON for downstream actions (also exported as POSTMAN_BRANCH_DECISION). |
|
|
197
|
+
| `spec-version-tag` | Native Spec Hub version tag created after successful canonical repo-sync finalization. |
|
|
198
|
+
| `spec-version-url` | Read-only URL for the tagged Spec Hub snapshot. |
|
|
190
199
|
<!-- outputs-table:end -->
|
|
191
200
|
|
|
192
201
|
## How it works
|
package/action.yml
CHANGED
|
@@ -119,9 +119,23 @@ inputs:
|
|
|
119
119
|
required: false
|
|
120
120
|
default: ""
|
|
121
121
|
credential-preflight:
|
|
122
|
-
description:
|
|
122
|
+
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.'
|
|
123
123
|
required: false
|
|
124
124
|
default: warn
|
|
125
|
+
branch-strategy:
|
|
126
|
+
description: "Branch-aware sync strategy. legacy (default) keeps branch-blind behavior; publish-gate restricts canonical writes to the canonical branch and skips repo-sync on other branches; preview additionally maintains suffixed per-branch preview asset sets."
|
|
127
|
+
required: false
|
|
128
|
+
default: legacy
|
|
129
|
+
canonical-branch:
|
|
130
|
+
description: Explicit canonical branch (the sole writer of canonical assets and tracked state). Defaults to the provider-resolved default branch; required on providers without a default-branch variable (Bitbucket, Azure DevOps) when branch-strategy is not legacy.
|
|
131
|
+
required: false
|
|
132
|
+
channels:
|
|
133
|
+
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.'
|
|
134
|
+
required: false
|
|
135
|
+
preview-ttl:
|
|
136
|
+
description: Sliding TTL in days for preview asset sets (refreshed on every successful preview sync; the retention contract of last resort when no provider credential is available for branch-existence checks).
|
|
137
|
+
required: false
|
|
138
|
+
default: '30'
|
|
125
139
|
github-token:
|
|
126
140
|
description: GitHub token used for repo variable persistence and commits.
|
|
127
141
|
required: false
|
|
@@ -150,6 +164,10 @@ inputs:
|
|
|
150
164
|
spec-id:
|
|
151
165
|
description: Spec Hub UID emitted by bootstrap's spec-id output. When set, it is persisted into .postman/resources.yaml cloudResources so later runs and the generated CI workflow can resolve the spec without re-discovery.
|
|
152
166
|
required: false
|
|
167
|
+
spec-content-changed:
|
|
168
|
+
description: Whether bootstrap changed canonical spec content. Native Spec Hub tag publication is skipped on no-op syncs.
|
|
169
|
+
required: false
|
|
170
|
+
default: 'true'
|
|
153
171
|
spec-path:
|
|
154
172
|
description: Optional repo-root-relative path to the local OpenAPI file. Recorded in .postman/resources.yaml and .postman/workflows.yaml metadata so the committed artifacts point back at the spec source in this repository; the file itself is not uploaded by this action.
|
|
155
173
|
required: false
|
|
@@ -180,6 +198,14 @@ outputs:
|
|
|
180
198
|
description: JSON summary of repo materialization and workspace sync outputs.
|
|
181
199
|
commit-sha:
|
|
182
200
|
description: Commit SHA produced by repo-write-mode, if any.
|
|
201
|
+
sync-status:
|
|
202
|
+
description: "Branch-aware sync status: synced, skipped-branch-gate, or empty under branch-strategy legacy."
|
|
203
|
+
branch-decision:
|
|
204
|
+
description: Serialized BranchDecision JSON for downstream actions (also exported as POSTMAN_BRANCH_DECISION).
|
|
205
|
+
spec-version-tag:
|
|
206
|
+
description: Native Spec Hub version tag created after successful canonical repo-sync finalization.
|
|
207
|
+
spec-version-url:
|
|
208
|
+
description: Read-only URL for the tagged Spec Hub snapshot.
|
|
183
209
|
runs:
|
|
184
210
|
using: node24
|
|
185
211
|
main: dist/action.cjs
|