@postman-cse/onboarding-insights 0.8.0 → 0.9.1

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 (6) hide show
  1. package/README.md +11 -11
  2. package/action.yml +6 -2
  3. package/dist/action.cjs +21733 -0
  4. package/dist/cli.cjs +10856 -17185
  5. package/dist/index.cjs +10804 -17104
  6. package/package.json +19 -9
package/README.md CHANGED
@@ -29,7 +29,7 @@ jobs:
29
29
  deploy:
30
30
  runs-on: ubuntu-latest
31
31
  steps:
32
- - uses: actions/checkout@v4
32
+ - uses: actions/checkout@v5
33
33
 
34
34
  # ... deploy your service to Kubernetes ...
35
35
 
@@ -52,7 +52,7 @@ jobs:
52
52
  provision:
53
53
  runs-on: ubuntu-latest
54
54
  steps:
55
- - uses: actions/checkout@v4
55
+ - uses: actions/checkout@v5
56
56
 
57
57
  - uses: postman-cs/postman-bootstrap-action@v0
58
58
  id: bootstrap
@@ -122,7 +122,7 @@ Output is JSON to stdout. Use `--result-json` to write the same payload to a fil
122
122
 
123
123
  ```yaml
124
124
  onboarding:
125
- image: node:20
125
+ image: node:24
126
126
  script:
127
127
  - npm install -g postman-insights-onboarding-action
128
128
  - postman-insights-onboard --project-name af-cards-activation --workspace-id "$WORKSPACE_ID" --environment-id "$ENVIRONMENT_ID" --postman-access-token "$POSTMAN_ACCESS_TOKEN" --postman-api-key "$POSTMAN_API_KEY" --cluster-name "$CLUSTER_NAME" --repo-url "$CI_PROJECT_URL" --poll-timeout-seconds 180 --result-json insights-result.json --dotenv-path insights.env
@@ -131,7 +131,7 @@ onboarding:
131
131
  ### Bitbucket Pipelines
132
132
 
133
133
  ```yaml
134
- image: node:20
134
+ image: node:24
135
135
 
136
136
  pipelines:
137
137
  default:
@@ -150,7 +150,7 @@ pool:
150
150
  steps:
151
151
  - task: NodeTool@0
152
152
  inputs:
153
- versionSpec: '20.x'
153
+ versionSpec: '24.x'
154
154
  - script: |
155
155
  npm install -g postman-insights-onboarding-action
156
156
  postman-insights-onboard --project-name af-cards-activation --workspace-id "$(WORKSPACE_ID)" --environment-id "$(ENVIRONMENT_ID)" --postman-access-token "$(POSTMAN_ACCESS_TOKEN)" --postman-api-key "$(POSTMAN_API_KEY)" --cluster-name "$(CLUSTER_NAME)" --repo-url "$(BUILD_REPOSITORY_URI)" --poll-timeout-seconds 180 --result-json insights-result.json --dotenv-path insights.env
@@ -167,7 +167,7 @@ steps:
167
167
  | `system-environment-id` | No | | Postman system environment UUID for service-level Insights acknowledgment. Falls back to the value from the discovered service record. |
168
168
  | `cluster-name` | No | | Insights cluster name. When set, the action matches `{cluster-name}/{project-name}` exactly. When omitted, falls back to suffix matching. |
169
169
  | `repo-url` | No | Auto-detected from CI when available | Repository URL used for Git onboarding. |
170
- | `postman-access-token` | Yes | | Postman session token for Bifrost API calls. See [Obtaining postman-access-token](#obtaining-postman-access-token-open-alpha). |
170
+ | `postman-access-token` | Yes | | Postman session token for Bifrost API calls. See [Obtaining postman-access-token](#obtaining-postman-access-token-customer-preview). |
171
171
  | `postman-team-id` | No | | Explicit Postman team ID for org-mode Bifrost requests. When omitted, the action leaves `x-entity-team-id` unset so Bifrost resolves team context from the access token. |
172
172
  | `github-token` | No | ambient `GITHUB_TOKEN` env when exported by the workflow | Optional GitHub token passed as `git_api_key` only when repository auth is required by the onboarding endpoint. |
173
173
  | `postman-api-key` | No | | Postman API key (`PMAK-*`) for the application binding call to the observability API. Auto-created from `postman-access-token` when omitted or invalid after a clear 401/403 validation failure. |
@@ -178,9 +178,9 @@ Supply `postman-team-id` only for org-mode tokens that require an explicit team
178
178
 
179
179
  If `postman-api-key` is omitted or the `/me` validation call returns `401` or `403`, the action creates a new API key via the Bifrost identity service using the `postman-access-token`. Network failures and unexpected validation responses fail the action instead of silently rotating credentials.
180
180
 
181
- ### Obtaining `postman-access-token` (Open Alpha)
181
+ ### Obtaining `postman-access-token` (Customer Preview)
182
182
 
183
- > **Open-alpha limitation:** The `postman-access-token` input requires a manually-extracted session token. There is currently no public API to exchange a Postman API key (PMAK) for an access token programmatically. This manual step will be eliminated before GA.
183
+ > **Customer Preview limitation:** The `postman-access-token` input requires a manually-extracted session token. There is currently no public API to exchange a Postman API key (PMAK) for an access token programmatically. This manual step will be eliminated before GA.
184
184
 
185
185
  The `postman-access-token` is a Postman session token (`x-access-token`) required for the Bifrost API Catalog onboarding endpoints. Without it, this action cannot function.
186
186
 
@@ -259,8 +259,8 @@ npm run build
259
259
 
260
260
  `npm run build` produces `dist/index.cjs`, the bundled action entrypoint referenced by `action.yml`.
261
261
 
262
- ## Open-Alpha Release Strategy
262
+ ## Customer Preview Release Strategy
263
263
 
264
- - Open-alpha channel tags use `v0.x.y`.
264
+ - Customer Preview channel tags use `v0.x.y`.
265
265
  - Consumers can pin immutable tags such as `v0.1.0` for reproducibility.
266
- - Moving tag `v0` is used as the rolling open-alpha channel.
266
+ - Moving tag `v0` is used as the rolling customer preview channel.
package/action.yml CHANGED
@@ -39,6 +39,10 @@ inputs:
39
39
  description: 'Seconds between discovery polling attempts'
40
40
  required: false
41
41
  default: '10'
42
+ postman-stack:
43
+ description: 'Postman stack profile.'
44
+ required: false
45
+ default: 'prod'
42
46
  outputs:
43
47
  discovered-service-id:
44
48
  description: 'Numeric ID from the API Catalog discovered-services list'
@@ -53,5 +57,5 @@ outputs:
53
57
  status:
54
58
  description: 'Onboarding result: success, not-found, or error'
55
59
  runs:
56
- using: 'node20'
57
- main: 'dist/index.cjs'
60
+ using: 'node24'
61
+ main: 'dist/action.cjs'