@postman-cs/onboarding-api 3.5.12 → 3.5.14

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 (3) hide show
  1. package/README.md +5 -4
  2. package/action.yml +15 -2
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
- # Postman API Onboarding
1
+ # Postman Enterprise Automation: API Onboarding
2
2
 
3
3
  [![CI](https://github.com/postman-cs/postman-api-onboarding-action/actions/workflows/ci.yml/badge.svg)](https://github.com/postman-cs/postman-api-onboarding-action/actions/workflows/ci.yml) [![Release](https://img.shields.io/github/v/release/postman-cs/postman-api-onboarding-action?sort=semver)](https://github.com/postman-cs/postman-api-onboarding-action/releases) [![npm](https://img.shields.io/npm/v/%40postman-cs%2Fonboarding-api)](https://www.npmjs.com/package/@postman-cs/onboarding-api) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
4
4
 
5
- Canonical entrypoint for the Postman API Onboarding suite. Use this composite action when a GitHub repository needs the full onboarding path: workspace bootstrap, OpenAPI upload, collection generation, repository artifact sync, built-in smoke and contract runs, and optional Postman Insights linking.
5
+ Canonical entrypoint for the Postman Enterprise Automation Suite. Use this composite action when a GitHub repository needs the full onboarding path: workspace bootstrap, OpenAPI upload, collection generation, repository artifact sync, built-in smoke and contract runs, and optional Postman Insights linking.
6
6
 
7
7
  > **The pipeline leaves executable, standards-grounded tests behind, not just assets.** Bootstrap injects spec-derived contract assertions into the `[Contract]` collection, the Smoke collection carries generated smoke scripts, and repo-sync writes a CI workflow that reruns both with the Postman CLI on every push, pull request, and schedule. Full inventories: [Generated assertions](https://github.com/postman-cs/postman-bootstrap-action/blob/main/docs/generated-assertions.md), [Smoke generated tests](https://github.com/postman-cs/postman-smoke-flow-action/blob/main/docs/generated-tests.md), and [Contract Enforcement Layers](https://github.com/postman-cs/postman-bootstrap-action/blob/main/docs/contract-enforcement-layers.md).
8
8
 
@@ -76,7 +76,7 @@ The built-in smoke and contract runs are warning-only. A successful onboarding s
76
76
 
77
77
  | Scenario | Start with | Why |
78
78
  | --- | --- | --- |
79
- | Full GitHub onboarding from an OpenAPI spec | [Postman API Onboarding](https://github.com/postman-cs/postman-api-onboarding-action) | Canonical suite entrypoint. Chains bootstrap, repo sync, tests, and optional Insights. |
79
+ | Full GitHub onboarding from an OpenAPI spec | [Postman Enterprise Automation: API Onboarding](https://github.com/postman-cs/postman-api-onboarding-action) | Canonical suite entrypoint. Chains bootstrap, repo sync, tests, and optional Insights. |
80
80
  | Mint an access token and resolve team ID | [Postman Onboarding: Service Token](https://github.com/postman-cs/postman-resolve-service-token-action) | Primary credential path for this composite action. Run it before onboarding. |
81
81
  | Discover an OpenAPI spec from AWS | [Postman Onboarding: AWS Spec Discovery](https://github.com/postman-cs/postman-aws-spec-discovery-action) | Produces a spec URL or artifact that can feed this composite action. |
82
82
  | Provision only the Postman workspace and collections | [Postman Onboarding: Workspace Bootstrap](https://github.com/postman-cs/postman-bootstrap-action) | Lower-level action for custom pipelines that do not want repo sync. |
@@ -294,6 +294,7 @@ The hook only attaches `x-api-key` for `*.mock.pstmn.io` hosts, so it stays iner
294
294
  | `onboarding-scope` | Onboarding scope. Use full for the complete pipeline or spec-only for workspace/spec onboarding without generated assets. | no | `full` |
295
295
  | `sync-examples` | Whether linked spec/collection relations should enable example syncing. | no | `true` |
296
296
  | `collection-sync-mode` | Collection lifecycle policy (refresh or version). Default refresh ensures tracked collections stay in sync with the spec. | no | `refresh` |
297
+ | `collection-update-strategy` | Collection update strategy (auto or whole). Default whole preserves full collection updates. | no | `whole` |
297
298
  | `spec-sync-mode` | Spec lifecycle policy (update or version). | no | `update` |
298
299
  | `release-label` | Optional release label for versioned specs and collections. When omitted during versioned sync, derived from GitHub tag or branch metadata. | no | |
299
300
  | `monitor-id` | Existing smoke monitor ID. When set, the action validates and reuses this monitor instead of creating a new one. | no | |
@@ -399,7 +400,7 @@ Tables are generated from `action.yml` by `npm run docs:tables`.
399
400
 
400
401
  ## How it works
401
402
 
402
- This is a composite action, the primary partner-facing entrypoint of the Postman onboarding suite. It chains up to four sibling actions in order:
403
+ This is a composite action, the primary partner-facing entrypoint of the Postman Enterprise Automation Suite. It chains up to four sibling actions in order:
403
404
 
404
405
  1. **Bootstrap** (`postman-cs/postman-bootstrap-action`) creates or reuses the workspace, uploads the spec to [Spec Hub](https://learning.postman.com/docs/design-apis/specifications/overview/), and [generates](https://learning.postman.com/docs/design-apis/specifications/generate-collections/) baseline, smoke, and contract collections.
405
406
  2. **Smoke flow** (`postman-cs/postman-smoke-flow-action`, when `flow-path` or `flow-mode` is set) reshapes the canonical Smoke collection before repo sync and the built-in test run: from the `flow.yaml` manifest at the effective flow path (`flow-path` or `postman/flow.yaml`) when one exists, otherwise derived deterministically from the spec under `flow-mode: auto` and persisted to that path. Repo sync then commits the manifest with the rest of the `postman/` tree and exports the post-reshape Smoke collection, so run 2 takes the curated path from the committed file; `derived-flow-path` reports where the manifest landed.
package/action.yml CHANGED
@@ -1,5 +1,5 @@
1
- name: Postman API Onboarding
2
- description: 'Full Postman onboarding in one step: workspace bootstrap, repo sync, and optional Insights linking. Part of the Postman API Onboarding suite.'
1
+ name: 'Postman Enterprise Automation: API Onboarding'
2
+ description: 'Workspace bootstrap, repo sync, and optional Insights linking in one step. Part of the Postman Enterprise Automation Suite.'
3
3
  author: Postman
4
4
  branding:
5
5
  icon: send
@@ -36,6 +36,10 @@ inputs:
36
36
  description: Collection lifecycle policy (refresh or version). Default refresh ensures tracked collections stay in sync with the spec.
37
37
  required: false
38
38
  default: refresh
39
+ collection-update-strategy:
40
+ description: Collection update strategy (auto or whole). Default whole preserves full collection updates.
41
+ required: false
42
+ default: whole
39
43
  spec-sync-mode:
40
44
  description: Spec lifecycle policy (update or version).
41
45
  required: false
@@ -643,6 +647,7 @@ runs:
643
647
  POSTMAN_REGION: ${{ inputs.postman-region }}
644
648
  POSTMAN_STACK: ${{ inputs.postman-stack }}
645
649
  WORKING_DIRECTORY: ${{ inputs.working-directory }}
650
+ COLLECTION_UPDATE_STRATEGY: ${{ inputs.collection-update-strategy }}
646
651
  SPEC_PATH: ${{ inputs.spec-path }}
647
652
  CREDENTIAL_PREFLIGHT: ${{ inputs.credential-preflight }}
648
653
  REPO_WRITE_MODE: ${{ inputs.repo-write-mode }}
@@ -698,6 +703,13 @@ runs:
698
703
  exit 1
699
704
  ;;
700
705
  esac
706
+ case "$COLLECTION_UPDATE_STRATEGY" in
707
+ auto|whole) ;;
708
+ *)
709
+ echo "::error::Attempted collection-update-strategy validation failed: the provided value is unsupported. Accepted values: auto, whole. Set the collection-update-strategy input to one of those values."
710
+ exit 1
711
+ ;;
712
+ esac
701
713
  if [ "$BRANCH_TIER" != "gated" ] && [ -z "$POSTMAN_API_KEY" ] && [ -z "$POSTMAN_ACCESS_TOKEN" ]; then
702
714
  echo "::error::Attempted onboarding credential validation failed: neither postman-api-key nor postman-access-token was supplied. Provide one of those inputs and rerun."
703
715
  exit 1
@@ -736,6 +748,7 @@ runs:
736
748
  onboarding-scope: ${{ inputs.onboarding-scope }}
737
749
  sync-examples: ${{ inputs.sync-examples }}
738
750
  collection-sync-mode: ${{ inputs.collection-sync-mode }}
751
+ collection-update-strategy: ${{ inputs.collection-update-strategy }}
739
752
  spec-sync-mode: ${{ inputs.spec-sync-mode }}
740
753
  release-label: ${{ inputs.release-label }}
741
754
  domain: ${{ inputs.domain }}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@postman-cs/onboarding-api",
3
- "version": "3.5.12",
3
+ "version": "3.5.14",
4
4
  "description": "Composite Postman API onboarding GitHub Action.",
5
5
  "files": [
6
6
  "action.yml",