From 5b0104d54e29699b2a4df25b0568ebc4dddf2f09 Mon Sep 17 00:00:00 2001 From: Yann Rouillard Date: Fri, 15 Mar 2024 00:46:02 +0100 Subject: [PATCH] doc: add info in README.md for kafka-check-schemas --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 5b27223..ef50747 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ Add this to your `.pre-commit-config.yaml` - id: check-branch-name - id: no-ephemeral-links exclude: '\.md$' + # [...] add other specific hook id relevant from your project ``` ### Hooks available @@ -41,8 +42,18 @@ Consequently to keep the code futureproof we don't want links to ephemeral thrid party stuff (slack, clubhouse, atlassian) #### `fastapi-generate-openapi-specification` + Generate the Open API spec from a Fast API. If it has changed, write the new one and fails. If not, succeeds. +#### `kafka-check-schemas` + +This hook is specific to Kafka Stream or Kafka Producers application and will check that the repositories contains AVRO schemas files, under the `schemas/` folder, that are consistent with the code. +The presence of such schemas is required by the Kpler GitHub actions [check-kafka-schemas-compatibility] and [upload-kafka-schemas] and is also mandatory for Kafka application deployment in Kubernetes. + +[check-kafka-schemas-compatibility]: https://github.com/Kpler/github-actions/blob/main/actions/kafka/check-kafka-schemas-compatibility/README.md +[upload-kafka-schemas]: https://github.com/Kpler/github-actions/blob/main/actions/kafka/upload-kafka-schemas/README.md + + ### Contributing #### Debugging / testing