@pact-foundation/pact 10.0.0-beta.9 → 10.0.0

package/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at pact-support@googlegroups.com. All
+reported by contacting the project team at pact-foundation@googlegroups.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

package/CONTRIBUTING.md

@@ -1,5 +1,9 @@
 # Contributing
 
+We love contributors! Pact-js is maintained and contrbuted to by developers just like you.
+
+We have a development channel in the pact-foundation [slack] (`#pact-js-development`).
+
 ## Raising issues
 
 Before raising an issue, make sure you have checked the open and closed issues to see if an answer is provided there.
@@ -11,18 +15,29 @@ Please provide the following information with your issue to enable us to respond
 - The steps to recreate your issue.
 - An executable code example where possible. You can fork this repository and use one of the [examples] to quickly recreate your issue.
 
-## Contributing features
+## Key Branches
+
+* `master` - this is the current main version supporting the 10.x.x release line. Most investment will be here, inclruding major new features, enhancements, bug fixes, security patches etc.
+* `9.x.x` - this is the previous major version supporting the 9.x.x release line. Critical security patches and bug fixes will be provided as a priority.
+
+## I want to contribute code but don't know where to start
 
-Hey, that's awesome you want to help! If you're not sure where to start, look for the [help wanted](https://github.com/pact-foundation/pact-js/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
-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.
+If you're not sure where to start, look for the [help wanted](https://github.com/pact-foundation/pact-js/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
+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.
 
-## Commit messages
+## I'm ready to contribute code
+
+Awesome! We have some guidelines here that will help your PR be accepted:
+
+### Commit messages
 
 Pact JS uses the [Conventional Changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)
-commit message conventions. Please ensure you follow the guidelines, we don't want to _be that person_, but the commit messages
-are very important to the automation of our release process.
+commit message conventions. Please ensure you follow the guidelines, as they
+help us automate our release process.
 
-Take a look at the git history (`git log`) to get the gist of it.
+You can take a look at the git history (`git log`) to get the gist of it.
+If you have questions, feel free to reach out in `#pact-js` in our [slack
+community](https://pact-foundation.slack.com/).
 
 If you'd like to get some CLI assistance, getting setup is easy:
 
@@ -33,17 +48,39 @@ npm i -g cz-conventional-changelog
 
 `git cz` to commit and commitizen will guide you.
 
+#### Release notes
+
+Commit messages with `fix` or `feat` prefixes will appear in the release notes. 
+These communicate changes that users may want to know about.
+
+* `feat(<scope>):` or `feat:` messages appear under "New Features", and trigger minor version bumps.
+* `fix(<scope>):` or `fix:` messages appear under "Fixes and improvements", and trigger patch version bumps.
+
+If your commit message introduces a breaking change, please include a footer that starts with `BREAKING CHANGE:`.
+For more information, please see the [Conventional Changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)
+guidelines.
+
+(Also, if you are committing breaking changes, you may want to check with the other maintainers on slack first).
+
+Examples of `fix` include bug fixes and dependency bumps that users of pact-js may want to know about.
+
+Examples of `feat` include new features and substantial modifications to existing features.
+
+Examples of things that we'd prefer not to appear in the release notes include documentation updates, 
+modified or new examples, refactorings, new tests, etc. We usually use one of `chore`, `style`, 
+`refactor`, or `test` as appropriate.
+
 ## Code style and formatting
 
-We use [Prettier](https://prettier.io/) for formatting, and for linting we use [TSLint](https://palantir.github.io/tslint/) (for TypeScript).
+We use [Prettier](https://prettier.io/) for formatting, and for linting we use [ESLint](https://eslint.org/) (for TypeScript).
 
-Please update your editor to enable Prettier, and things should be easy 👌. If not, our lint step will catch it.
+The recommended approach is to configure Prettier to format on save in your editor 👌. If not, don't worry, our lint step will catch it.
 
 ## Pull requests
 
-- Write tests for any changes
-- Follow existing code style and conventions
-- Separate unrelated changes into multiple pull requests
+- Please write tests for any changes
+- Please follow existing code style and conventions
+- Please separate unrelated changes into multiple pull requests
 - For bigger changes, make sure you start a discussion first by creating an issue and explaining the intended change
 
 [stackoverflow]: https://stackoverflow.com/questions/tagged/pact

package/MIGRATION.md

@@ -0,0 +1,77 @@
+# Pact-js migration guide
+
+# 9.x.x -> 10.x.x
+
+See the [9.x.x -> 10.x.x](/docs/migrations/9-10.md) migration guide.
+
+# beta.62
+
+Removed the default export for v3 in the root package in preparation for a release.
+
+# beta.61
+
+* new `addInteraction` method on PactV3 to support previous JSON-style interactions
+* remove `VerifierV3` as many beta versions have passed with this deprecation notice and won't be in final release
+* remove `json()` method from consumer message pact
+* add new `WithBinaryContent` method for consumer messages
+* add binary content support to messages via `WithBinaryContent`
+* add text content support to messages via `WithTextContent`
+* Remove all Ruby dependencies in DSLs
+* `pactfileWriteMode` still supports the same options, however the behaviour of `overwrite` is such now that it will overwrite the pact file _per test_, not pact run of Pact. This is because there is no longer a single long running mock server as per previous versions. Set to `merge` or leave blank for a sensible default. 
+* As per the change to `pactfileWriteMode` this also means pact files should be cleared out prior to each test, to avoid extraneous interactions in a pact file.
+* Array matcher currently doesn't work on query strings (see https://github.com/pact-foundation/pact-reference/issues/205). However, an array with matchers is supported (see jest spec)
+* the `mockService` property on the `Pact` class is no longer an actual `MockService`, but supports the `baseUrl` property.
+* Manually controlling the state of the mock server - such as removing interactions - has been removed.
+
+# beta.56
+
+Migrates to a new handle based verifier. This adds several layers of improvement, including better error handling/response output (which will be added in later versions).
+
+* Drop support for migrating `disableSSLVerification` (correct field is `**disableSslVerification**`)
+* Handle based verifier doesn't support environment variables (i.e. `PACT_BROKER_*`)
+
+This guide is for migrating to a new version of pact-js.
+# beta.52
+
+The following matchers now must have an explicit example provided:
+
+* `datetime`
+* `timestamp`
+* `time`
+
+# beta.47
+
+Change uses of `RFC3339_TIMESTAMP_FORMAT` or `Matchers.rfc1123Timestamp()` to
+`RFC1123_TIMESTAMP_FORMAT` and `rfc1123Timestamp` respectively (this matcher
+has always been RFC1123, not RFC3339).
+
+# beta.44 to beta.45
+
+You no longer need to use `VerifierV3`. You may now do:
+
+```
+import { Verifier } from '@pact-foundation/pact'
+```
+
+If migrating from VerifierV3, note that `disableSSLVerification` has been
+renamed `disableSslVerification` for consistency with other options.
+The `VerifierV3` still exists with the old options, it now delegates to the main verifier.
+
+## Verifier Options
+
+There are several changes to the `VerifierOptions`. To migrate:
+
+- Replace `verbose` with `logLevel: "DEBUG"` (logLevels of `DEBUG` and below now imply `verbose` where appropriate)
+- Replace `consumerVersionTag` with the `consumerVersionTags` array
+- Replace `providerVersionTag` with the `providerVersionTags` array
+- Replace `tags` with `consumerVersionTags` or `providerVersionTags` as appropriate.
+
+Some options have been removed entirely:
+
+- `customProviderHeaders` has been removed. If you need this functionality, set an
+  appropriate request filter with the `requestFilters` option instead.
+- All logging and reporting is now on standard out (this was the default before).
+  This means `logDir` / `format` / `out` have all been removed. If your ecosystem needs
+  the ability to customise logging and reporting, please let us know by opening an issue.
+- The undocumented option `monkeypatch` has been removed. The use cases for this
+  feature are mostly covered by other options.