From 1b4c72c791780345caef72971bde1f3267b0cbe1 Mon Sep 17 00:00:00 2001 From: Github Action Date: Thu, 10 Oct 2024 12:11:42 +0000 Subject: [PATCH] chore: synced all docs --- .../docs/docs/examples/aws/sns/consumer/readme.md | 4 ++-- .../docs/docs/examples/dotnet/consumer/readme.md | 6 +++--- .../docs/docs/examples/dotnet/provider/readme.md | 14 ++++++++------ .../docs/docs/examples/golang/consumer/readme.md | 4 +--- .../docs/docs/examples/golang/provider/readme.md | 13 ++++++++----- .../docs/examples/java/consumer/graphql/readme.md | 4 ++-- .../examples/java/provider-springboot/readme.md | 2 ++ website/docs/docs/examples/js/consumer/readme.md | 2 +- website/docs/docs/examples/kafka/java/consumer.md | 6 +++--- website/docs/docs/examples/kafka/java/provider.md | 11 ++++------- website/docs/docs/examples/soap/java/consumer.md | 6 +++--- website/docs/docs/examples/soap/java/provider.md | 6 +++--- 12 files changed, 40 insertions(+), 38 deletions(-) diff --git a/website/docs/docs/examples/aws/sns/consumer/readme.md b/website/docs/docs/examples/aws/sns/consumer/readme.md index e00bb9a8..e31fd743 100644 --- a/website/docs/docs/examples/aws/sns/consumer/readme.md +++ b/website/docs/docs/examples/aws/sns/consumer/readme.md @@ -1,7 +1,7 @@ --- custom_edit_url: https://github.com/pactflow/example-consumer-js-sns/edit/master/README.md -title: Example Node AWS SNS Consumer -sidebar_label: Example Node AWS SNS Consumer +title: Example NodeJS AWS SNS Consumer +sidebar_label: Example NodeJS AWS SNS Consumer --- diff --git a/website/docs/docs/examples/dotnet/consumer/readme.md b/website/docs/docs/examples/dotnet/consumer/readme.md index a07a0a86..3f26e5dd 100644 --- a/website/docs/docs/examples/dotnet/consumer/readme.md +++ b/website/docs/docs/examples/dotnet/consumer/readme.md @@ -13,9 +13,9 @@ https://github.com/pactflow/example-consumer-dotnet [![Build](https://github.com/pactflow/example-consumer-dotnet/actions/workflows/build.yml/badge.svg)](https://github.com/pactflow/example-consumer-dotnet/actions/workflows/build.yml) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-dotnet/consumer/pactflow-example-consumer-dotnet/latest/badge.svg?label=provider)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-dotnet/consumer/pactflow-example-consumer-dotnet/latest) (latest pact) +![Can I Deploy](https://testdemo.pactflow.io/pacticipants/pactflow-example-consumer-dotnet/branches/master/latest-version/can-i-deploy/to-environment/production/badge) -[![Pact Status](https://testdemo.pactflow.io/matrix/provider/pactflow-example-provider-dotnet/latest/prod/consumer/pactflow-example-consumer-dotnet/latest/prod/badge.svg?label=provider)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-dotnet/consumer/pactflow-example-consumer-dotnet/latest/prod) (prod/prod pact) +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-dotnet/consumer/pactflow-example-consumer-dotnet/latest/badge?label=provider) (latest pact) This is an example of a dotnet core consumer using Pact to create a consumer driven contract, and sharing it via [PactFlow](https://pactflow.io). @@ -36,7 +36,7 @@ The project uses a Makefile to simulate a very simple build pipeline with two st * Docker * A [PactFlow](https://pactflow.io) account * A [read/write API Token](https://docs.pactflow.io/#configuring-your-api-token) from your PactFlow account -* .NET 6.x installed. You can install it from here: https://docs.microsoft.com/en-us/dotnet/core/install/macos +* .NET 8.x installed. You can install it from here: https://docs.microsoft.com/en-us/dotnet/core/install ## Usage diff --git a/website/docs/docs/examples/dotnet/provider/readme.md b/website/docs/docs/examples/dotnet/provider/readme.md index 4b96e726..92ee3495 100644 --- a/website/docs/docs/examples/dotnet/provider/readme.md +++ b/website/docs/docs/examples/dotnet/provider/readme.md @@ -1,7 +1,7 @@ --- custom_edit_url: https://github.com/pactflow/example-provider-dotnet/edit/master/README.md -title: Example Provider -sidebar_label: Example Provider +title: Example Provider Dotnet +sidebar_label: Example Provider Dotnet --- @@ -11,13 +11,15 @@ sidebar_label: Example Provider https://github.com/pactflow/example-provider-dotnet -[![Build](https://github.com/pactflow/example-provider-dotnet/actions/workflows/build.yml/badge.svg)](https://github.com/pactflow/example-provider-dotnet/actions/workflows/build.yml) +[![Build](https://github.com/pactflow/example-provider-dotnet/actions/workflows/build.yml/badge)](https://github.com/pactflow/example-provider-dotnet/actions/workflows/build.yml) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-dotnet/consumer/pactflow-example-consumer-dotnet/latest/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-dotnet/consumer/pactflow-example-consumer-dotnet/latest/badge.svg) (latest) +![Can I Deploy](https://testdemo.pactflow.io/pacticipants/pactflow-example-provider-dotnet/branches/master/latest-version/can-i-deploy/to-environment/production/badge) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-dotnet/consumer/pactflow-example-consumer-dotnet/latest/prod/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-dotnet/consumer/pactflow-example-consumer-dotnet/latest/prod/badge.svg) (prod) +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-dotnet/consumer/pactflow-example-consumer-dotnet/latest/badge) (latest) -This is an example of a .NET 8 provider that uses Pact, [PactFlow](https://pactflow.io) and Travis CI to ensure that it is compatible with the expectations its consumers have of it. +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-dotnet/consumer/pactflow-example-consumer-dotnet/latest/prod/badge) (prod) + +This is an example of a .NET 8 provider that uses Pact, [PactFlow](https://pactflow.io) and GitHub Actions to ensure that it is compatible with the expectations its consumers have of it. The project uses a Makefile to simulate a very simple build pipeline with two stages - test and deploy. diff --git a/website/docs/docs/examples/golang/consumer/readme.md b/website/docs/docs/examples/golang/consumer/readme.md index 37906fb4..a8a48696 100644 --- a/website/docs/docs/examples/golang/consumer/readme.md +++ b/website/docs/docs/examples/golang/consumer/readme.md @@ -13,9 +13,7 @@ https://github.com/pactflow/example-consumer-golang ![Build](https://github.com/pactflow/example-consumer-golang/workflows/Build/badge.svg) -[![Pact Status](https://test.pactflow.io/pacts/provider/pactflow-example-provider-golang/consumer/pactflow-example-consumer-golang/latest/badge.svg?label=provider)](https://test.pactflow.io/pacts/provider/pactflow-example-provider-golang/consumer/pactflow-example-consumer-golang/latest) (latest pact) - -[![Pact Status](https://test.pactflow.io/matrix/provider/pactflow-example-provider-golang/latest/prod/consumer/pactflow-example-consumer-golang/latest/prod/badge.svg?label=provider)](https://test.pactflow.io/pacts/provider/pactflow-example-provider-golang/consumer/pactflow-example-consumer-golang/latest/prod) (prod/prod pact) +![Can I Deploy](https://testdemo.pactflow.io/pacticipants/pactflow-example-consumer-golang/branches/master/latest-version/can-i-deploy/to-environment/production/badge) This is an example of a Golang consumer using Pact to create a consumer driven contract, and sharing it via [PactFlow](https://pactflow.io). diff --git a/website/docs/docs/examples/golang/provider/readme.md b/website/docs/docs/examples/golang/provider/readme.md index 41d81ee3..b4527ee6 100644 --- a/website/docs/docs/examples/golang/provider/readme.md +++ b/website/docs/docs/examples/golang/provider/readme.md @@ -15,9 +15,6 @@ https://github.com/pactflow/example-provider-golang [![Can I deploy Status](https://test.pactflow.io/pacticipants/pactflow-example-provider-golang/branches/master/latest-version/can-i-deploy/to-environment/production/badge.svg)](https://test.pactflow.io/overview/provider/pactflow-example-consumer-golang/consumer/pactflow-example-consumer-golang) -[![Pact Status](https://test.pactflow.io/pacts/provider/pactflow-example-provider-golang/consumer/pactflow-example-consumer-golang/latest/badge.svg)](https://test.pactflow.io/pacts/provider/pactflow-example-provider-golang/consumer/pactflow-example-consumer-golang/latest) (latest pact) - -[![Pact Status](https://test.pactflow.io/pacts/provider/pactflow-example-provider-golang/consumer/pactflow-example-consumer-golang/latest/master/badge.svg)](https://test.pactflow.io/pacts/provider/pactflow-example-provider-golang/consumer/pactflow-example-consumer-golang/latest/master) (master/master pact) This is an example of a (Gin-based) Golang provider that uses Pact, [PactFlow](https://pactflow.io) and GitHub Actions to ensure that it is compatible with the expectations its consumers have of it. The project uses a Makefile to simulate a very simple build pipeline with two stages - test and deploy. @@ -26,10 +23,16 @@ It is using a public tenant on PactFlow, which you can access [here](https://tes ## Pre-Requisites -Ruby standalone binaries must be installed, the following script will download them and add them to your system PATH +In order to use pact-go v2, you must install pact ffi system libraries to your machine. + +``` +make install +``` + +In order to use the pact cli tools, which interact with a pact broker, the Ruby standalone binaries must be installed, the following script will download them and add them to your system PATH ``` -make install_ruby_standalone +make install_cli ``` ## Usage diff --git a/website/docs/docs/examples/java/consumer/graphql/readme.md b/website/docs/docs/examples/java/consumer/graphql/readme.md index d0a9a89d..c6e9ddcf 100644 --- a/website/docs/docs/examples/java/consumer/graphql/readme.md +++ b/website/docs/docs/examples/java/consumer/graphql/readme.md @@ -13,9 +13,9 @@ https://github.com/pactflow/example-consumer-java-graphql ![Build](https://github.com/pactflow/example-consumer-java-graphql/workflows/Build/badge.svg) -[![Can I deploy Status](https://test.pactflow.io/pacticipants/pactflow-example-consumer-java-graphql/branches/master/latest-version/can-i-deploy/to-environment/production/badge.svg)](https://test.pactflow.io/overview/provider/pactflow-example-provider-java-graphql/consumer/pactflow-example-consumer-java-graphql) +[![Can I deploy Status](https://test.pactflow.io/pacticipants/pactflow-example-consumer-java-graphql/branches/master/latest-version/can-i-deploy/to-environment/production/badge)](https://testdemo.pactflow.io/pacticipants/pactflow-example-consumer-java-graphql) -[![Pact Status](https://test.pactflow.io/pacts/provider/pactflow-example-provider-java-graphql/consumer/pactflow-example-consumer-java-graphql/latest/badge.svg)](https://test.pactflow.io/pacts/provider/pactflow-example-provider-java-graphql/consumer/pactflow-example-consumer-java-graphql/latest) (latest pact) +![Pact Status](https://test.pactflow.io/pacts/provider/pactflow-example-provider-java-graphql/consumer/pactflow-example-consumer-java-graphql/latest/badge.svg) (latest pact) This is an example of a Java GraphQL consumer that uses Pact with Junit, [Pactflow](https://pactflow.io) and GitHub Actions to ensure that it is compatible with the expectations its consumers have of it. diff --git a/website/docs/docs/examples/java/provider-springboot/readme.md b/website/docs/docs/examples/java/provider-springboot/readme.md index 3bd14b49..85a7ef61 100644 --- a/website/docs/docs/examples/java/provider-springboot/readme.md +++ b/website/docs/docs/examples/java/provider-springboot/readme.md @@ -49,6 +49,8 @@ The project uses a Makefile to simulate a very simple build pipeline with two st See the [PactFlow CI/CD Workshop](https://github.com/pactflow/ci-cd-workshop). +>_Note:_ This repository is designed, out the box to work with the [`example-consumer-java-junit`](https://github.com/pactflow/example-consumer-java-junit) project, which specifies the provider it depends on, as the one named in this repository (`pactflow-example-provider-springboot`). If you are using another consumer example such as the [`pactflow-example-consumer`](https://github.com/pactflow/example-consumer) repo, you should do one of the following in your consumer project, either override the environment variable `PACT_PROVIDER=pactflow-example-provider-springboot` or update [the test](https://github.com/pactflow/example-consumer/blob/master/src/api.pact.spec.js#L9) to specify the correct provider name. + The below commands are designed for a Linux/OSX environment, please translate for use on Windows/PowerShell as necessary: Please ensure the following environment variables have been exported in the process that you run the tests (generally a terminal): diff --git a/website/docs/docs/examples/js/consumer/readme.md b/website/docs/docs/examples/js/consumer/readme.md index a758a4c4..3aeaf0e4 100644 --- a/website/docs/docs/examples/js/consumer/readme.md +++ b/website/docs/docs/examples/js/consumer/readme.md @@ -11,7 +11,7 @@ sidebar_label: Example Consumer https://github.com/pactflow/example-consumer -![Build](https://github.com/pactflow/example-consumer/workflows/Build/badge.svg) +[![Build](https://github.com/pactflow/example-consumer/actions/workflows/build.yml/badge.svg)](https://github.com/pactflow/example-consumer/actions/workflows/build.yml) [![Pact Status](https://test.pactflow.io/pacts/provider/pactflow-example-provider/consumer/pactflow-example-consumer/latest/badge.svg?label=provider)](https://test.pactflow.io/pacts/provider/pactflow-example-provider/consumer/pactflow-example-consumer/latest) (latest pact) diff --git a/website/docs/docs/examples/kafka/java/consumer.md b/website/docs/docs/examples/kafka/java/consumer.md index 3fd8cdd6..d5419ef0 100644 --- a/website/docs/docs/examples/kafka/java/consumer.md +++ b/website/docs/docs/examples/kafka/java/consumer.md @@ -14,11 +14,11 @@ https://github.com/pactflow/example-consumer-java-kafka ![Build](https://github.com/pactflow/example-consumer-java-kafka/workflows/Build/badge.svg) -[![Can I deploy Status](https://testdemo.pactflow.io/pacticipants/pactflow-example-consumer-java-kafka/branches/master/latest-version/can-i-deploy/to-environment/production/badge.svg)](https://testdemo.pactflow.io/overview/provider/pactflow-example-consumer-java-kafka/consumer/pactflow-example-consumer-js-kafka) +[![Can I deploy Status](https://testdemo.pactflow.io/pacticipants/pactflow-example-consumer-java-kafka/branches/master/latest-version/can-i-deploy/to-environment/production/badge)](https://testdemo.pactflow.io/pacticipants/pactflow-example-consumer-java-kafka) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest) (latest pact) +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest/badge) (latest pact) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest/master/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest/master) (master/master pact) +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest/master/badge) (master/master pact) This is an example of a Java kafka consumer that uses Pact, [PactFlow](https://pactflow.io) and GitHub Actions to ensure that it is compatible with the expectations its consumers have of it. diff --git a/website/docs/docs/examples/kafka/java/provider.md b/website/docs/docs/examples/kafka/java/provider.md index 42522011..bd282420 100644 --- a/website/docs/docs/examples/kafka/java/provider.md +++ b/website/docs/docs/examples/kafka/java/provider.md @@ -13,15 +13,12 @@ https://github.com/pactflow/example-provider-java-kafka ![Build](https://github.com/pactflow/example-provider-java-kafka/workflows/Build/badge.svg) -[![Can I deploy Status](https://testdemo.pactflow.io/pacticipants/pactflow-example-provider-java-kafka/branches/master/latest-version/can-i-deploy/to-environment/production/badge.svg)](https://testdemo.pactflow.io/overview/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-js-kafka) +[![Can I deploy Status](https://testdemo.pactflow.io/pacticipants/pactflow-example-provider-java-kafka/branches/master/latest-version/can-i-deploy/to-environment/production/badge)](https://testdemo.pactflow.io/pacticipants/pactflow-example-provider-java-kafka) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest) (latest pact) +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest/badge)(latest pact) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-js-kafka/latest/badge)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-js-kafka/latest) (latest pact) +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest/master/badge) (master/master pact) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest/master/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-java-kafka/latest/master) (master/master pact) - -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-js-kafka/latest/master/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-kafka/consumer/pactflow-example-consumer-js-kafka/latest/master) (master/master pact) This is an example of a Java Spring Boot Kafka Producer that uses Pact, [PactFlow](https://pactflow.io) and GitHub Actions to ensure that it is compatible with the expectations its consumers have of it. @@ -37,7 +34,7 @@ In the following diagram, we'll be testing the "Event API", a service that publi **Software**: * Tools listed at: https://docs.pactflow.io/docs/workshops/ci-cd/set-up-ci/prerequisites/ -* Java (11+) +* Java (17+) * A pactflow.io account with an valid [API token](https://docs.pactflow.io/docs/getting-started/#configuring-your-api-token) ### Environment variables diff --git a/website/docs/docs/examples/soap/java/consumer.md b/website/docs/docs/examples/soap/java/consumer.md index 92b557ae..5199e7db 100644 --- a/website/docs/docs/examples/soap/java/consumer.md +++ b/website/docs/docs/examples/soap/java/consumer.md @@ -13,11 +13,11 @@ https://github.com/pactflow/example-consumer-java-soap ![Build](https://github.com/pactflow/example-consumer-java-soap/workflows/Build/badge.svg) -[![Can I deploy Status](https://testdemo.pactflow.io/pacticipants/pactflow-example-consumer-java-soap/branches/master/latest-version/can-i-deploy/to-environment/production/badge.svg)](https://testdemo.pactflow.io/overview/provider/pactflow-example-consumer-java-soap/consumer/pactflow-example-consumer-js-soap) +[![Can I deploy Status](https://testdemo.pactflow.io/pacticipants/pactflow-example-consumer-java-soap/branches/master/latest-version/can-i-deploy/to-environment/production/badge)](https://testdemo.pactflow.io/overview/provider/pactflow-example-consumer-java-soap/consumer/pactflow-example-consumer-js-soap) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest) (latest pact) +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest/badge) (latest pact) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest/master/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest/master) (master/master pact) +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest/master/badge) (master/master pact) This is an example of a Java SOAP consumer that uses Pact, [PactFlow](https://pactflow.io) and GitHub Actions to ensure that it is compatible with the expectations its consumers have of it. diff --git a/website/docs/docs/examples/soap/java/provider.md b/website/docs/docs/examples/soap/java/provider.md index dba54dc2..17697096 100644 --- a/website/docs/docs/examples/soap/java/provider.md +++ b/website/docs/docs/examples/soap/java/provider.md @@ -13,11 +13,11 @@ https://github.com/pactflow/example-provider-java-soap ![Build](https://github.com/pactflow/example-provider-java-soap/workflows/Build/badge.svg) -[![Can I deploy Status](https://testdemo.pactflow.io/pacticipants/pactflow-example-provider-java-soap/branches/master/latest-version/can-i-deploy/to-environment/production/badge.svg)](https://testdemo.pactflow.io/overview/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-soap) +![Can I deploy Status](https://testdemo.pactflow.io/pacticipants/pactflow-example-provider-java-soap/branches/master/latest-version/can-i-deploy/to-environment/production/badge) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest) (latest pact) +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest/badge) (latest pact) -[![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest/master/badge.svg)](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest/master) (master/master pact) +![Pact Status](https://testdemo.pactflow.io/pacts/provider/pactflow-example-provider-java-soap/consumer/pactflow-example-consumer-java-soap/latest/master/badge) (master/master pact) This is an example of a Java XML provider that uses Pact, [PactFlow](https://pactflow.io) and GitHub Actions to ensure that it is compatible with the expectations its consumers have of it.