Add pre-commit check to check integrations table.#36497
Conversation
|
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
|
|
@potiuk Could you give some first feedback on this? Particularly, I am not sure about auto generating the table, as the description part is missing. Could the description be pulled from the |
Generally looks cool. We do not have descriptions yet. But we can possibly also already improve the `integration-*.yml" files and add description there (and read it from there) See: https://docs.docker.com/compose/compose-file/compose-file-v3/#reference-and-guidelines - you could add "labels" and we could standardize to use version: "3.8"
services:
kafka:
image: ....
labels:
breeze.description: "This label will appear on all containers for the web service"As a follow-up we could update "version" and "labels" for other files (for airflow service we only need to set label for "base.yml". |
|
@potiuk Thank's for the feedback, pushed 2 commits, which should cover it.
I did not change the base.yml in this PR as it is not part of Maybe this is what you meant, but would it make sense to create another PR for standardizing
|
Yep. Absolutely. Separate PR, And having pre-commit to check it is a good idea :) |
|
Some other pre-commits need to be run and fixed :). I highly recomment |
|
Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions. |
|
Cool ! |
(cherry picked from commit 9d1eba0)
(cherry picked from commit 9d1eba0)
Add pre-commit check to check if integrations and TESTING documentation are synchronized.
The new pre-commit test:
integration-*.ymlfilesTESTING.rst