You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/feature_request.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,15 +19,15 @@ _This checklist is optional, but studies show that people who have followed it c
19
19
20
20
Before making a feature request, I have:
21
21
22
-
-[ ][Searched the issues to check that this feature hasn't been requested before](https://github.com/pact-foundation/pact-node/issues?q=is%3Aissue)
22
+
-[ ][Searched the issues to check that this feature hasn't been requested before](https://github.com/pact-foundation/pact-js-core/issues?q=is%3Aissue)
23
23
-[ ] Checked the documentation to see if it is possible to do what I want already
24
24
25
25
### Feature description
26
26
27
-
_Please describe what you would like Pact-node to do_
27
+
_Please describe what you would like Pact-js-core to do_
28
28
29
29
### Use case
30
30
31
31
_What is the use case that motivates this feature request?_
32
32
33
-
_Please describe *why* you would like Pact-node to have this feature._
33
+
_Please describe *why* you would like Pact-js-core to have this feature._
Copy file name to clipboardExpand all lines: .github/issue_template.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ _Thank you for reporting an issue! We appreciate it very much. Issues are a big
2
2
3
3
_NOTE: If your issue is a how-to question, it is probably better asked in the pact-foundation slack channel, https://slack.pact.io/ _
4
4
5
-
_This is the template for issues that aren't feature requests or bug reports. If your issue is a feature request or bug report, please use the relevant template from https://github.com/pact-foundation/pact-node/issues/new/choose - these will cover off the most common questions we ask and speed up a fix_
5
+
_This is the template for issues that aren't feature requests or bug reports. If your issue is a feature request or bug report, please use the relevant template from https://github.com/pact-foundation/pact-js-core/issues/new/choose - these will cover off the most common questions we ask and speed up a fix_
6
6
7
7
_If you're reading this thinking "Hmmm, it is bug report/feature request, but neither of those templates work for what I want to report", then please feel free to ignore the template in whatever way you think best suits your issue. We trust you, you're awesome_
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,8 @@ Please provide the following information with your issue to enable us to respond
13
13
14
14
## I want to contribute code but don't know where to start
15
15
16
-
If you're not sure where to start, look for the [help wanted](https://github.com/pact-foundation/pact-node/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
17
-
label in our issue tracker. If you have an idea that you think would be great, come and chat to us on [slack] in the `#pact-node` channel, or open a feature request issue.
16
+
If you're not sure where to start, look for the [help wanted](https://github.com/pact-foundation/pact-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
17
+
label in our issue tracker. If you have an idea that you think would be great, come and chat to us on [slack] in the `#pact-js` channel, or open a feature request issue.
18
18
19
19
## I'm ready to contribute code
20
20
@@ -26,7 +26,7 @@ Pact Node uses the [Conventional Changelog](https://github.com/bcoe/conventional
26
26
commit message conventions to simplify automation process. Please ensure you follow the guidelines.
27
27
28
28
You can take a look at the git history (`git log`) to get the gist of it.
29
-
If you have questions, feel free to reach out in `#pact-node` in our [slack
29
+
If you have questions, feel free to reach out in `#pact-js` in our [slack
An idiomatic Node wrapper for the [Pact](http://pact.io)[CLI Tools](https://github.com/pact-foundation/pact-ruby-standalone).
12
+
**This is the core of pact-js. Unless you are wanting to develop tools for the pact ecosystem, you almost certainly want to install [`@pact-foundation/pact`](https://github.com/pact-foundation/pact-js/) instead**.
13
13
14
-
***NOTE*: If you are new to Pact and are wanting to get started with contract testing, you almost certainly don't want to use this package. Head over to [Pact JS](https://github.com/pact-foundation/pact-js/) instead.**
14
+
A wrapper for the [Pact](http://pact.io)[CLI Tools](https://github.com/pact-foundation/pact-ruby-standalone).
15
+
16
+
***If you are new to Pact and are wanting to get started with contract testing, you almost certainly don't want to use this package. Head over to [Pact JS](https://github.com/pact-foundation/pact-js/) instead.**
@@ -79,7 +81,7 @@ For those that are behind a corporate firewall or are seeing issues where our pa
79
81
}
80
82
```
81
83
82
-
It will accept both a local path or an http(s) url. It must point to the directory containing the binary needed as the binary name is appended to the end of the location. For the example given above, Pact will look for the binary at `/home/some-user/Downloads/pact-1.44.0-win32.zip` for a Windows system. However, by using this method, you must use the correct Pact version binary associated with this version of Pact-Node. For extra security measurements, checksum validation has been added to prevent tampering with the binaries.
84
+
It will accept both a local path or an http(s) url. It must point to the directory containing the binary needed as the binary name is appended to the end of the location. For the example given above, Pact will look for the binary at `/home/some-user/Downloads/pact-1.44.0-win32.zip` for a Windows system. However, by using this method, you must use the correct Pact version binary associated with this version of Pact-Core. For extra security measurements, checksum validation has been added to prevent tampering with the binaries.
83
85
84
86
If your environment uses self-signed certificates from an internal Certificate Authority (CA), you can configure this using the standard options in an [npmrc](https://docs.npmjs.com/configuring-npm/npmrc.html) file as per below:
85
87
@@ -95,7 +97,7 @@ You can also force Pact to skip the installation of the binary during `npm insta
95
97
setting `PACT_SKIP_BINARY_INSTALL=true`. This feature is useful if you want to speed up
96
98
builds that don't need Pact and don't want to modify your projects dependencies.
97
99
98
-
Note that pact-node will not be functional without the binary.
100
+
Note that pact-core will not be functional without the binary.
99
101
100
102
```bash
101
103
PACT_SKIP_BINARY_INSTALL=true npm install
@@ -121,7 +123,7 @@ TL;DR - you almost always want Pact JS.
121
123
Simply require the library and call the create function to start the mock service
Remove all servers once you're done with them in one fell swoop.
204
206
205
207
```js
206
-
var pact =require("@pact-foundation/pact-node");
208
+
var pact =require("@pact-foundation/pact-core");
207
209
pact.removeAllServers();
208
210
```
209
211
@@ -212,7 +214,7 @@ pact.removeAllServers();
212
214
Start the current server.
213
215
214
216
```js
215
-
var pact =require("@pact-foundation/pact-node");
217
+
var pact =require("@pact-foundation/pact-core");
216
218
pact.createServer()
217
219
.start()
218
220
.then(function() {
@@ -225,7 +227,7 @@ pact.createServer()
225
227
Stop the current server.
226
228
227
229
```js
228
-
var pact =require("@pact-foundation/pact-node");
230
+
var pact =require("@pact-foundation/pact-core");
229
231
pact.createServer()
230
232
.stop()
231
233
.then(function() {
@@ -238,7 +240,7 @@ pact.createServer()
238
240
Stop the current server and deletes it from the list.
239
241
240
242
```js
241
-
var pact =require("@pact-foundation/pact-node");
243
+
var pact =require("@pact-foundation/pact-core");
242
244
pact.createServer()
243
245
.delete()
244
246
.then(function() {
@@ -249,7 +251,7 @@ pact.createServer()
249
251
#### Check if a Mock server is running
250
252
251
253
```js
252
-
var pact =require("@pact-foundation/pact-node");
254
+
var pact =require("@pact-foundation/pact-core");
253
255
pact.createServer().running;
254
256
```
255
257
@@ -258,7 +260,7 @@ pact.createServer().running;
258
260
There's 3 different events available, 'start', 'stop' and 'delete'. They can be listened to the same way as an [EventEmitter](https://nodejs.org/api/events.html).
These are available in circumstances where `pact-node` has not yet implemented a feature or access via JavaScript APIs is not desirable. To run the binaries is as simple as the following:
459
+
These are available in circumstances where `pact-core` has not yet implemented a feature or access via JavaScript APIs is not desirable. To run the binaries is as simple as the following:
458
460
459
461
*Example can-i-deploy check*:
460
462
```sh
@@ -482,7 +484,7 @@ The following are the binaries currently made available:
482
484
483
485
### Enable Long Paths
484
486
485
-
[Windows has a default path length limit of 260](https://docs.microsoft.com/en-us/windows/desktop/fileio/naming-a-file#maximum-path-length-limitation) causing issues with projects that are nested deep inside several directory and with how npm handles node_modules directory structures. To fix this issue, please enable Windows Long Paths in the registry by running `regedit.exe`, find the key `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem\LongPathsEnabled` and change the value from `0` to `1`, then reboot your computer. Pact should now work as it should, if not, please [raise an issue on github](https://github.com/pact-foundation/pact-node/issues).
487
+
[Windows has a default path length limit of 260](https://docs.microsoft.com/en-us/windows/desktop/fileio/naming-a-file#maximum-path-length-limitation) causing issues with projects that are nested deep inside several directory and with how npm handles node_modules directory structures. To fix this issue, please enable Windows Long Paths in the registry by running `regedit.exe`, find the key `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem\LongPathsEnabled` and change the value from `0` to `1`, then reboot your computer. Pact should now work as it should, if not, please [raise an issue on github](https://github.com/pact-foundation/pact-js-core/issues).
Copy file name to clipboardExpand all lines: RELEASING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ dependencies in `scripts/ci/lib`.
36
36
## Kicking off a release
37
37
38
38
You must be able to create a github access token with `repo` scope to the
39
-
pact-node repository.
39
+
pact-js-core repository.
40
40
41
41
- Set an environment variable `GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES` to this token.
42
42
- Make sure master contains the code you want to release
@@ -69,7 +69,7 @@ may need to rebase them on top of the tagged release commit and force push.
69
69
70
70
## Releasing Pact Node Manually
71
71
72
-
If any changes needs to be released, let it be dependencies or code, you must have access to push directly to master on the pact-node repo, then follow these steps:
72
+
If any changes needs to be released, let it be dependencies or code, you must have access to push directly to master on the pact-js-core repo, then follow these steps:
73
73
74
74
- Run `npm ci --ignore-scripts` to confirm that the dependencies are appropriately configured.
75
75
- Run `npm test` first to make sure all tests pass. This will also build and download the appropriate checksums.
0 commit comments