pmpact 0.4.5 → 0.4.7
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 +31 -27
- package/RELEASE.md +20 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
# pmpact
|
|
2
2
|
|
|
3
|
-
A command line tool to convert [
|
|
3
|
+
A command line tool to convert [_Pact_](https://docs.pact.io/) files to [_Postman_](https://www.getpostman.com/) collections.
|
|
4
4
|
|
|
5
5
|
## Contents
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
7
|
+
- [Requirements](#requirements)
|
|
8
|
+
- [Installation](#installation)
|
|
9
|
+
- [Installation from the repo](#installation-from-the-repo)
|
|
10
|
+
- [Command line usage](#command-line-usage)
|
|
11
|
+
- [From a url](#from-a-url)
|
|
12
|
+
- [From a file](#from-a-file)
|
|
13
|
+
- [Save to a file](#save-to-a-file)
|
|
14
|
+
- [From a url that requires headers](#from-a-url-that-requires-headers)
|
|
15
|
+
- [Postman usage](#postman-usage)
|
|
16
|
+
- [Import the collection in _Postman_](#import-the-collection-in-postman)
|
|
17
|
+
- [Create a _Postman_ environment](#create-a-postman-environment)
|
|
18
|
+
- [Run tests](#run-tests)
|
|
19
|
+
- [Run all tests](#run-all-tests)
|
|
20
|
+
- [Run unit tests only](#run-unit-tests-only)
|
|
21
|
+
- [Run integration tests only](#run-integration-tests-only)
|
|
22
|
+
- [License](#license)
|
|
23
23
|
|
|
24
24
|
## Requirements
|
|
25
25
|
|
|
26
|
-
Requires [
|
|
26
|
+
Requires [_NodeJS_](https://nodejs.org/en/) version `v20.11` or higher.
|
|
27
27
|
|
|
28
28
|
## Installation
|
|
29
29
|
|
|
@@ -68,22 +68,22 @@ pmpact http://pact-broker/provider/a-provider/consumer/a-consumer/latest -o post
|
|
|
68
68
|
pmpact http://pact-broker/provider/a-provider/consumer/a-consumer/latest -H '{"Authorization":"Basic ZFhmbHR5Rk1n..."}'
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
##
|
|
71
|
+
## _Postman_ usage
|
|
72
72
|
|
|
73
|
-
### Import the collection in
|
|
73
|
+
### Import the collection in _Postman_
|
|
74
74
|
|
|
75
|
-
Once you have a generated [
|
|
75
|
+
Once you have a generated [_Postman_ collection](https://www.getpostman.com/docs/v6/postman/collections/intro_to_collections), select "import" in _Postman_. The generated collection format is `2.1`.
|
|
76
76
|
|
|
77
77
|
A collection should appear, starting with the name "Pact".
|
|
78
78
|
|
|
79
|
-
### Create a
|
|
79
|
+
### Create a _Postman_ environment
|
|
80
80
|
|
|
81
|
-
A url variable is used for all the requests. The next step is to create an [
|
|
81
|
+
A url variable is used for all the requests. The next step is to create an [_Postman_ environment](https://www.getpostman.com/docs/v6/postman/environments_and_globals/intro_to_environments_and_globals) with a url variable, for example: `url: http://my-service.com`.
|
|
82
82
|
|
|
83
|
-
1. 
|
|
84
|
-
2. 
|
|
85
|
-
3. 
|
|
86
|
-
4. 
|
|
83
|
+
1. 
|
|
84
|
+
2. 
|
|
85
|
+
3. 
|
|
86
|
+
4. 
|
|
87
87
|
|
|
88
88
|
You're good to go - so make the requests!
|
|
89
89
|
|
|
@@ -115,6 +115,10 @@ nodemon tests/unit -x "npm run test-unit"
|
|
|
115
115
|
nodemon tests/integration -x "npm run test-integration"
|
|
116
116
|
```
|
|
117
117
|
|
|
118
|
+
## Release process
|
|
119
|
+
|
|
120
|
+
When contributing, the process we adhere to for releases is found in [RELEASE.md](./RELEASE.md).
|
|
121
|
+
|
|
118
122
|
## License
|
|
119
123
|
|
|
120
124
|
[See License file](https://github.com/ITV/pmpact/blob/master/LICENSE.md)
|
package/RELEASE.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Release Process for New Versions
|
|
2
|
+
|
|
3
|
+
> [!IMPORTANT]
|
|
4
|
+
> Reminder: this repository is publicly listed package on npm – [PMPact on npm](https://www.npmjs.com/package/pmpact).
|
|
5
|
+
|
|
6
|
+
> [!NOTE]
|
|
7
|
+
> The following process is primarily aimed at internal contributors. However, if you wish to contribute to this repository you are more than welcome; please do reach out and open a PR.
|
|
8
|
+
|
|
9
|
+
Follow this release process:
|
|
10
|
+
|
|
11
|
+
1. Make your changes.
|
|
12
|
+
2. Test.
|
|
13
|
+
3. ✅ Get reviews and sign off.
|
|
14
|
+
4. **Squash and merge** into `main` branch.
|
|
15
|
+
5. On `main` branch – do `npm version patch`.
|
|
16
|
+
- Push commit created to GitHub – _you may need `main` branch to be temporarily un-protected_.
|
|
17
|
+
- Push tag created to GitHub.
|
|
18
|
+
6. Publish code and tag to [npm](https://www.npmjs.com/).
|
|
19
|
+
- You will need an npm account.
|
|
20
|
+
- You will need to be added to the relevant team/organisation.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pmpact",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.7",
|
|
4
4
|
"description": "A command line tool to convert Pact files to Postman collections.",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
},
|
|
31
31
|
"homepage": "https://github.com/ITV/pmpact#readme",
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"axios": "1.
|
|
33
|
+
"axios": "1.13.2",
|
|
34
34
|
"commander": "4.1.1",
|
|
35
35
|
"debug": "4.3.4",
|
|
36
36
|
"http-status": "1.6.2",
|