Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: improve kafka-check-schemas commit hook #34

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Open

refactor: improve kafka-check-schemas commit hook #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down