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

🧹doc: update connectors README and remove acceptance-test-docker.sh #32209

Merged

Conversation

alafanechere
Copy link
Contributor

@alafanechere alafanechere commented Nov 6, 2023

What

Relates to #30767
Our connectors README were stale because:

  • Connectors are not built via docker build or (gradle for python connectors) anymore
  • CAT is not run via docker run but wrapped into airbyte-ci, which makes its Dockerfile and acceptance-test-docker.sh script legacy

How

  • Remove all reference to Gradle from the python connector README
  • Update README to reflect the up-to-date way of building/testing/publishing connectors
  • Remove all acceptance-test-docker.sh scripts

Copy link

vercel bot commented Nov 6, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
airbyte-docs ⬜️ Ignored (Inspect) Visit Preview Nov 6, 2023 6:03pm

Copy link
Contributor

github-actions bot commented Nov 6, 2023

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@octavia-squidington-iii octavia-squidington-iii added the area/connectors Connector related issues label Nov 6, 2023
@alafanechere alafanechere marked this pull request as ready for review November 6, 2023 18:04
@alafanechere alafanechere requested review from a team as code owners November 6, 2023 18:04
@alafanechere alafanechere changed the title update connector README and remove acceptance-test-docker.sh update connectors README and remove acceptance-test-docker.sh Nov 6, 2023
@octavia-squidington-iv octavia-squidington-iv requested a review from a team November 6, 2023 18:05
@alafanechere alafanechere changed the title update connectors README and remove acceptance-test-docker.sh 🧹doc: update connectors README and remove acceptance-test-docker.sh Nov 6, 2023
Copy link
Contributor

@evantahler evantahler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!
Is there a template we need to update as well?

@alafanechere
Copy link
Contributor Author

Nice!
Is there a template we need to update as well?

@evantahler #32211

@alafanechere
Copy link
Contributor Author

/approve-and-merge reason="doc only update triggering connector tests"

@octavia-approvington
Copy link
Contributor

Check that box
TODO complete

@octavia-approvington octavia-approvington merged commit 368ba78 into master Nov 6, 2023
@octavia-approvington octavia-approvington deleted the augustin/11-06-modernize-connector-readme branch November 6, 2023 18:36
@AF414
Copy link

AF414 commented Jan 30, 2024

Looks like the Iterable README got mixed up with the Coinmarketcap README? Happy to make a PR. just want to confirm.

@alafanechere
Copy link
Contributor Author

@AF414 yes indeed! Sorry for this. Feel free to make the PR and ask a review from me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants