Skip to content

Commit

Permalink
Merge pull request #307 from pactflow/all-docs-updated
Browse files Browse the repository at this point in the history
chore: synced all docs
  • Loading branch information
YOU54F authored Oct 10, 2024
2 parents 6b5dc3e + 1b4c72c commit a78b569
Show file tree
Hide file tree
Showing 12 changed files with 40 additions and 38 deletions.
4 changes: 2 additions & 2 deletions website/docs/docs/examples/aws/sns/consumer/readme.md
Original file line number Diff line number Diff line change
@@ -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
---

<!-- This file has been synced from the pactflow/example-consumer-js-sns repository. Please do not edit it directly. The URL of the source file can be found in the custom_edit_url value above -->
Expand Down
6 changes: 3 additions & 3 deletions website/docs/docs/examples/dotnet/consumer/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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

Expand Down
14 changes: 8 additions & 6 deletions website/docs/docs/examples/dotnet/provider/readme.md
Original file line number Diff line number Diff line change
@@ -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
---

<!-- This file has been synced from the pactflow/example-provider-dotnet repository. Please do not edit it directly. The URL of the source file can be found in the custom_edit_url value above -->
Expand All @@ -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.

Expand Down
4 changes: 1 addition & 3 deletions website/docs/docs/examples/golang/consumer/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
13 changes: 8 additions & 5 deletions website/docs/docs/examples/golang/provider/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/docs/docs/examples/java/consumer/graphql/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions website/docs/docs/examples/java/provider-springboot/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
2 changes: 1 addition & 1 deletion website/docs/docs/examples/js/consumer/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
6 changes: 3 additions & 3 deletions website/docs/docs/examples/kafka/java/consumer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
11 changes: 4 additions & 7 deletions website/docs/docs/examples/kafka/java/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions website/docs/docs/examples/soap/java/consumer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions website/docs/docs/examples/soap/java/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit a78b569

Please sign in to comment.