Generate connectors.md
#23367
Generate connectors.md
#23367
Conversation
evantahler
requested review from
pedroslopez,
davinchia,
bnchrch and
sherifnada
There was a problem hiding this comment.
Love the spirit and presentation of this. Let merge it in.
For context, in the future this file may take on a different "form" as metadata likely willl:
- Make the catalog the primary reference point and the definition yamls will go away.
- Move the generation of the catalog outside of CI/CD and not checked into the repository.
| final List<JsonNode> destinationDefinitionsJson = getSeedJson(seedRoot, SeedConnectorType.DESTINATION.getDefinitionFileName()); | ||
| final List<JsonNode> sourceDefinitionsJson = getSeedJson(seedRoot, SeedConnectorType.SOURCE.getDefinitionFileName()); |
There was a problem hiding this comment.
Are we ok with introducing a new usage of the YAMLs?
There was a problem hiding this comment.
I very much hope this file one day is built by our metadata service. I view this as a transitionary step - if we can get folks looking here, and not the actor definitions, than the pain of removing them is lessened.
airbyte-config/specs/src/main/java/io/airbyte/config/specs/ConnectorMarkdownGenerator.java
Show resolved
Hide resolved
|
@evantahler the file is breaking CI. It fails the check The timestamp for |
|
This PR will catch the problem above in tests for the future #23370 |
This PR adds an automatically-generated
connectors.mdfile at the root of this directory. It takes the information contained within the actor_definition files and builds a human-readable markdown table any time a connector is added or updated.This answers the question - "What's the official list of connectors"?
In the future, once all connector metadata lives within this repo, we can add cloud status and additional information. This happens automatically as part of the
/publishworkflow, keyed as a dependency of:airbyte-config:init:processResourcesView the file here