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.

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

ci-connector-ops: enforce connector metadata checks on connector PR #20707

Closed
alafanechere opened this issue Dec 20, 2022 · 1 comment
Closed
Labels

Comments

@alafanechere
Copy link
Contributor

alafanechere commented Dec 20, 2022

Tell us about the problem you're trying to solve

@evantahler recently accomplished huge grooming chores of our connector's documentation:
#20274
#19865
#20666

We don't want to perform this cleaning anymore and would like to enforce clean docs / connector metadata before they merge into the master branch.

Describe the solution you’d like

When a connector version is bumped in a PR we should check that:

  • A documentation file is available for this connector in docs/integrations/*
  • The changelog was correctly updated
  • The connector image was published to our docker registry (this is already done by the Ensure Image exists check)
  • A valid version number is used?
  • Enforce the presence of a valid connector icon? (already tracked in Connector Ops CI Checks enforces that Beta+ connectors include an icon #19448)

Benefits:

  • CAT team and members of the maintainer program will benefit from automated checks that can help improve the quality of their PR reviews
  • It will help keep a consistent connector catalog with quality artifacts used on Airbyte cloud (connector docs, icon)

Where should this be coded?

We had an interesting discussion here about where this kind of check should happen.
As the connector metadata we are checking are not part of the Airbyte protocol at the moment I think these check should not happen in SAT. I suggest to add the metadata validation logic to ci-connector-ops.
We would ideally have a CLI command targeting a connector folder and performing the check.
We'd run this command from the Connector Ops CI workflow.
We should keep in mind that we plan to enable connector development outside of the monorepo in a near future. It would be nice to make sure that these checks can be performed in this context without huge refacto.

@alafanechere alafanechere changed the title ci-connector-ops: enforce up to date changelog on connector PR ci-connector-ops: enforce connector metadata checks on connector PR Dec 20, 2022
@alafanechere
Copy link
Contributor Author

Closing as this is part of the QA checks of this project #21709

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant