@postman-cse/onboarding-bootstrap 0.15.2 → 1.0.0
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 +15 -10
- package/action.yml +5 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
# postman-bootstrap-action
|
|
2
2
|
|
|
3
|
+
[](https://github.com/postman-cs/postman-bootstrap-action/actions/workflows/ci.yml)
|
|
4
|
+
[](https://github.com/postman-cs/postman-bootstrap-action/releases)
|
|
5
|
+
[](https://www.npmjs.com/package/@postman-cse/onboarding-bootstrap)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
|
|
3
8
|
Public customer preview GitHub Action for Postman workspace bootstrap from a registry-backed OpenAPI spec.
|
|
4
9
|
|
|
5
10
|
## Scope
|
|
@@ -65,7 +70,7 @@ Postman organizations with multiple sub-teams (squads) require an explicit `work
|
|
|
65
70
|
**Example (GitHub Actions):**
|
|
66
71
|
|
|
67
72
|
```yaml
|
|
68
|
-
- uses: postman-cs/postman-bootstrap-action@
|
|
73
|
+
- uses: postman-cs/postman-bootstrap-action@v1
|
|
69
74
|
with:
|
|
70
75
|
project-name: core-payments
|
|
71
76
|
spec-url: https://example.com/openapi.yaml
|
|
@@ -131,7 +136,7 @@ For Git-first workflows the spec is usually checked into the same repo that runs
|
|
|
131
136
|
|
|
132
137
|
```yaml
|
|
133
138
|
- uses: actions/checkout@v5
|
|
134
|
-
- uses: postman-cs/postman-bootstrap-action@
|
|
139
|
+
- uses: postman-cs/postman-bootstrap-action@v1
|
|
135
140
|
with:
|
|
136
141
|
project-name: core-payments
|
|
137
142
|
spec-path: apis/core-payments/openapi.yaml
|
|
@@ -161,7 +166,7 @@ Example:
|
|
|
161
166
|
- uses: actions/checkout@v5
|
|
162
167
|
with:
|
|
163
168
|
fetch-depth: 0
|
|
164
|
-
- uses: postman-cs/postman-bootstrap-action@
|
|
169
|
+
- uses: postman-cs/postman-bootstrap-action@v1
|
|
165
170
|
with:
|
|
166
171
|
project-name: core-payments
|
|
167
172
|
spec-path: apis/core-payments/openapi.yaml
|
|
@@ -184,7 +189,7 @@ jobs:
|
|
|
184
189
|
contents: read
|
|
185
190
|
steps:
|
|
186
191
|
- uses: actions/checkout@v5
|
|
187
|
-
- uses: postman-cs/postman-bootstrap-action@
|
|
192
|
+
- uses: postman-cs/postman-bootstrap-action@v1
|
|
188
193
|
with:
|
|
189
194
|
project-name: core-payments
|
|
190
195
|
domain: core-banking
|
|
@@ -200,7 +205,7 @@ jobs:
|
|
|
200
205
|
runs-on: ubuntu-latest
|
|
201
206
|
steps:
|
|
202
207
|
- uses: actions/checkout@v5
|
|
203
|
-
- uses: postman-cs/postman-bootstrap-action@
|
|
208
|
+
- uses: postman-cs/postman-bootstrap-action@v1
|
|
204
209
|
with:
|
|
205
210
|
project-name: core-payments
|
|
206
211
|
workspace-id: ws-123
|
|
@@ -452,7 +457,7 @@ Configure this repository variable for the org-mode workspace creation check:
|
|
|
452
457
|
Refresh the current collections in place while keeping one canonical spec:
|
|
453
458
|
|
|
454
459
|
```yaml
|
|
455
|
-
- uses: postman-cs/postman-bootstrap-action@
|
|
460
|
+
- uses: postman-cs/postman-bootstrap-action@v1
|
|
456
461
|
with:
|
|
457
462
|
project-name: core-payments
|
|
458
463
|
spec-url: https://example.com/openapi.yaml
|
|
@@ -464,7 +469,7 @@ Refresh the current collections in place while keeping one canonical spec:
|
|
|
464
469
|
Create a versioned spec and collection set on the checked-out ref:
|
|
465
470
|
|
|
466
471
|
```yaml
|
|
467
|
-
- uses: postman-cs/postman-bootstrap-action@
|
|
472
|
+
- uses: postman-cs/postman-bootstrap-action@v1
|
|
468
473
|
with:
|
|
469
474
|
project-name: core-payments
|
|
470
475
|
spec-url: https://example.com/openapi.yaml
|
|
@@ -550,9 +555,9 @@ npm run build
|
|
|
550
555
|
|
|
551
556
|
## Customer Preview Release Strategy
|
|
552
557
|
|
|
553
|
-
- Customer Preview channel tags use `
|
|
554
|
-
- Consumers can pin immutable tags such as `
|
|
555
|
-
- Moving tag `
|
|
558
|
+
- Customer Preview channel tags use `v1.x.y`.
|
|
559
|
+
- Consumers can pin immutable tags such as `v1.0.0` for reproducibility.
|
|
560
|
+
- Moving tag `v1` is used only as the rolling customer preview channel.
|
|
556
561
|
|
|
557
562
|
## REST Migration Seam
|
|
558
563
|
|
package/action.yml
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
name: postman-bootstrap-action
|
|
2
|
-
description:
|
|
2
|
+
description: Create or reuse a Postman workspace, upload an OpenAPI spec, and generate baseline, smoke, and contract collections.
|
|
3
|
+
author: Postman
|
|
4
|
+
branding:
|
|
5
|
+
icon: box
|
|
6
|
+
color: orange
|
|
3
7
|
inputs:
|
|
4
8
|
|
|
5
9
|
workspace-id:
|