docs: update rules_pact and main docs

README.md

@@ -14,8 +14,9 @@ Providing a technical way to enhance collaboration within a team or within multi
 
 ### Currently
 - build has been succesfully ran on macos-darwin64 and linux-amd64 platforms
-- no extra tools needs to be installed to build (a part Bazel of course)
+- no extra tools needs to be installed to build (a part from Bazel of course)
 - the build is taking around 10 minutes, the most difficult part is to ensure cache usages (a part the first build)
+- the monorepo is releasing [rules_pact](https://github.com/opicaud/monorepo/blob/main/rules_pact/README.md)
 
 ### Stats
 | #Build | Cache | Time | Build type | Cache time |

rules_pact/BUILD.bazel

@@ -1,5 +1,5 @@
 load("@rules_pact//:defs.bzl", "pact_protobuf_plugin_toolchain", "pact_reference_toolchain")
-
+load("@bazel_skylib//rules:diff_test.bzl", "diff_test")
 load("@@//hack:release.bzl", "release_me")
 
 release_me()
@@ -43,7 +43,7 @@ load("@stardoc//stardoc:stardoc.bzl", "stardoc")
 stardoc(
  name = "docs",
  input = "@rules_pact//:defs.bzl",
- out = "README.md",
+ out = "docs.md",
  deps = [":bzl_lib"]
 )
 load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
@@ -59,6 +59,12 @@ bzl_library(
 )
 
 
+diff_test(
+ name = "docs_diff_test",
+ file1 = ":docs",
+ file2 = ":README.md",
+)
+
 exports_files(
  glob(["defs.bzl"]),
  visibility = ["//visibility:public"],

rules_pact/README.md

@@ -0,0 +1,140 @@
+<!-- Generated with Stardoc: http://skydoc.bazel.build -->
+
+# rules_pact
+Bazel rules to test services interactions with [pacts][pactsws]
+
+[pactsws]: https://docs.pact.io/
+
+- [consumer](#consumer)
+- [provider](#provider)
+- [side_car](#side_car)
+- [pact_test](#pact_test)
+- [pact_reference_toolchain](#pact_reference_toolchain)
+- [pact_protobuf_plugin_toolchain](#pact_protobuf_plugin_toolchain)
+
+<a id="consumer"></a>
+
+## consumer
+
+<pre>
+consumer(<a href="#consumer-name">name</a>, <a href="#consumer-srcs">srcs</a>, <a href="#consumer-data">data</a>)
+</pre>
+
+Rule that wrap consumer interaction.
+It executes the test provided in srcs attribute through the toolchain.
+This rule will be executed from the pact_test rule.
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| <a id="consumer-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
+| <a id="consumer-srcs"></a>srcs | a test target | <a href="https://bazel.build/concepts/labels">Label</a> | optional | `None` |
+| <a id="consumer-data"></a>data | data useful to provide with test target | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | `[]` |
+
+
+<a id="pact_protobuf_plugin_toolchain"></a>
+
+## pact_protobuf_plugin_toolchain
+
+<pre>
+pact_protobuf_plugin_toolchain(<a href="#pact_protobuf_plugin_toolchain-name">name</a>, <a href="#pact_protobuf_plugin_toolchain-manifest">manifest</a>, <a href="#pact_protobuf_plugin_toolchain-protobuf_plugin">protobuf_plugin</a>)
+</pre>
+
+A pact protobuf plugin toolchain
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| <a id="pact_protobuf_plugin_toolchain-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
+| <a id="pact_protobuf_plugin_toolchain-manifest"></a>manifest | A json manifest | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
+| <a id="pact_protobuf_plugin_toolchain-protobuf_plugin"></a>protobuf_plugin | A pact protobuf plugin binary | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
+
+
+<a id="pact_reference_toolchain"></a>
+
+## pact_reference_toolchain
+
+<pre>
+pact_reference_toolchain(<a href="#pact_reference_toolchain-name">name</a>, <a href="#pact_reference_toolchain-libpact_ffi">libpact_ffi</a>, <a href="#pact_reference_toolchain-pact_verifier_cli">pact_verifier_cli</a>)
+</pre>
+
+A pact reference toolchain
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| <a id="pact_reference_toolchain-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
+| <a id="pact_reference_toolchain-libpact_ffi"></a>libpact_ffi | A pact ffi library | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
+| <a id="pact_reference_toolchain-pact_verifier_cli"></a>pact_verifier_cli | A pact reference binary | <a href="https://bazel.build/concepts/labels">Label</a> | required | |
+
+
+<a id="pact_test"></a>
+
+## pact_test
+
+<pre>
+pact_test(<a href="#pact_test-name">name</a>, <a href="#pact_test-consumer">consumer</a>, <a href="#pact_test-provider">provider</a>)
+</pre>
+
+
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| <a id="pact_test-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
+| <a id="pact_test-consumer"></a>consumer | - | <a href="https://bazel.build/concepts/labels">Label</a> | optional | `None` |
+| <a id="pact_test-provider"></a>provider | - | <a href="https://bazel.build/concepts/labels">Label</a> | optional | `None` |
+
+
+<a id="provider"></a>
+
+## provider
+
+<pre>
+provider(<a href="#provider-name">name</a>, <a href="#provider-deps">deps</a>, <a href="#provider-srcs">srcs</a>, <a href="#provider-opts">opts</a>)
+</pre>
+
+Rule that describe provider interaction
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| <a id="provider-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
+| <a id="provider-deps"></a>deps | any useful dep to run with the provider like a state-manager, a proxy or a side-car | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | `[]` |
+| <a id="provider-srcs"></a>srcs | the provider to run | <a href="https://bazel.build/concepts/labels">Label</a> | optional | `None` |
+| <a id="provider-opts"></a>opts | options to provide to pact_verifier_cli | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | optional | `{}` |
+
+
+<a id="side_car"></a>
+
+## side_car
+
+<pre>
+side_car(<a href="#side_car-name">name</a>, <a href="#side_car-srcs">srcs</a>, <a href="#side_car-data">data</a>, <a href="#side_car-env">env</a>, <a href="#side_car-health_check">health_check</a>, <a href="#side_car-opts">opts</a>)
+</pre>
+
+
+
+**ATTRIBUTES**
+
+
+| Name | Description | Type | Mandatory | Default |
+| :------------- | :------------- | :------------- | :------------- | :------------- |
+| <a id="side_car-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
+| <a id="side_car-srcs"></a>srcs | the side-car to run | <a href="https://bazel.build/concepts/labels">Label</a> | optional | `None` |
+| <a id="side_car-data"></a>data | any data useful to run with the side-car, like a configuration file for instance | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | `[]` |
+| <a id="side_car-env"></a>env | any environment variable to provide with the side_car | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | optional | `{}` |
+| <a id="side_car-health_check"></a>health_check | uri to curl before launching provider test | String | optional | `"nop"` |
+| <a id="side_car-opts"></a>opts | the option specific to the side-car | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | optional | `{}` |
+
+