@postman-cse/onboarding-repo-sync 2.1.9 → 2.1.10

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.
Files changed (5) hide show
  1. package/README.md +21 -0
  2. package/dist/action.cjs +15583 -6561
  3. package/dist/cli.cjs +15522 -6496
  4. package/dist/index.cjs +15583 -6560
  5. package/package.json +15 -12
package/README.md CHANGED
@@ -199,6 +199,26 @@ with:
199
199
  | `spec-version-url` | Read-only URL for the tagged Spec Hub snapshot. |
200
200
  <!-- outputs-table:end -->
201
201
 
202
+ ## Self-contained binary (no npm / no Node)
203
+
204
+ For CI that cannot install npm or Node — locked-down Jenkins, bare Bitbucket agents, boxes with no package-registry access — a single self-contained executable is published as a GitHub Release asset. It bakes the Node runtime and the full bundle into one file, so the target needs no npm, no Node install, and no package-registry access. It is not network-isolated: the run still needs outbound access to the Postman API/gateway.
205
+
206
+ ```bash
207
+ VERSION=2.1.10 # example: use a release that carries the binary
208
+ ASSET="postman-repo-sync-${VERSION}-linux-x64"
209
+ BASE_URL="https://github.com/postman-cs/postman-repo-sync-action/releases/download/v${VERSION}"
210
+ curl -fsSLO "${BASE_URL}/${ASSET}"
211
+ curl -fsSLO "${BASE_URL}/${ASSET}.sha256"
212
+ shasum -a 256 -c "${ASSET}.sha256"
213
+ chmod +x "$ASSET"
214
+ mv "$ASSET" postman-repo-sync
215
+
216
+ export POSTMAN_ACCESS_TOKEN="<minted-token>"
217
+ ./postman-repo-sync --project-name core-payments --workspace-id ws-123 --repo-write-mode commit-only --result-json postman-repo-sync-result.json
218
+ ```
219
+
220
+ Credentials resolve from a CLI flag, then the `INPUT_*` env var, then a plain `POSTMAN_ACCESS_TOKEN` / `POSTMAN_API_KEY` — so Jenkins `withCredentials` works with no flag. Proxy-only agents must set `NODE_USE_ENV_PROXY=1` alongside `HTTP_PROXY` / `HTTPS_PROXY`. The binary pulls **no extra tooling onto the agent on any path** (even with a `postman-api-key`, which is only used to mint the access token). Two things to know for locked-down runs: the commit modes shell out to `git` (the binary bundles Node, not git), and with `generate-ci-workflow: true` (default) the workflow file it writes will — *when your CI later runs it* — install the Postman CLI from `dl-cli.pstmn.io`. Current target is `linux-x64`. Full runbook, credential minting, the complete host allowlist, and a Jenkins pipeline: [Self-contained binary](docs/self-contained-binary.md).
221
+
202
222
  ## How it works
203
223
 
204
224
  The action syncs a Postman workspace into the checked-out repository and can connect the workspace back to that repository:
@@ -269,6 +289,7 @@ Deeper reference:
269
289
  - [Artifact layout and Collection v3 format](docs/artifact-layout.md), including sync modes and versioned releases.
270
290
  - [Credentials](docs/credentials.md): `postman-api-key`, `postman-access-token`, credential preflight, GitHub tokens.
271
291
  - [CLI usage](docs/cli.md): the `postman-repo-sync` binary for GitLab CI, Bitbucket Pipelines, and Azure DevOps.
292
+ - [Self-contained binary](docs/self-contained-binary.md): the no-npm/no-Node release binary for locked-down agents — install, credential minting, host allowlist, and a Jenkins pipeline.
272
293
  - [Security](SECURITY.md): supported releases, reporting, and secret-handling expectations.
273
294
  - [Support](SUPPORT.md): where to ask usage questions and what diagnostics to include.
274
295
  - [Release policy](RELEASE_POLICY.md): immutable version tags and the rolling `v1` alias.