Repository navigation
docs: add testing and CI notes to CONTRIBUTING.md - #1420
Aaron ("AJ") Steers (aaronsteers) wants to merge 1 commit into
Conversation
Co-Authored-By: AJ Steers <aj@airbyte.io>
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. 💡 Show Tips and TricksTesting This PyAirbyte VersionYou can test this version of PyAirbyte using the following: # Run PyAirbyte CLI from this branch:
uvx --from 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1792820577-contributing-testing-ci' pyairbyte --help
# Install PyAirbyte from this branch for development:
pip install 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1792820577-contributing-testing-ci'PR Slash CommandsAirbyte Maintainers can execute the following slash commands on your PR:
📚 Show Repo GuidanceHelpful ResourcesCommunity SupportQuestions? Join the #pyairbyte channel in our Slack workspace. |
There was a problem hiding this comment.
🟢 Approval recommended
The documentation matches the existing CI behavior and introduces no runtime changes or unresolved issues.
No open issues 🎉
What changed in this PR
Adds repository-specific testing and CI guidance to CONTRIBUTING.md, moving this guidance out of the shared ai-skills repository.
Changes:
- Identifies the pytest workflow as the source of truth for the OS and Python matrix.
- Clarifies no-credentials job exclusions, credential handling, and fork behavior.
- Documents credential-test marking and safe integration debugging.
| File | Description |
|---|---|
CONTRIBUTING.md |
Adds a “Testing and CI” section covering CI interpretation and credential safety. |
Review effort: Balanced
Code coverage overviewLanguages: Python Python / code-coverage/pytest-no-creds
View coverage of the 10 most impacted files.
Python / code-coverage/pytest
View coverage of the 10 most impacted files.
Python / code-coverage/pytest-unit
Line coverage data for the release-candidate/v1 branch is not yet available. View coverage of the 10 most covered files.
ℹ️ Calculations represent line coverage. Results may change as calculations are updated. Updated |
Summary
Adds a "Testing and CI" section to
CONTRIBUTING.md. It moves the one PyAirbyte-only rule out of ai-skills; ai-skills#1092 deletes that rule, since repo-specific facts belong in the repo itself..github/workflows/python_pytest.ymlis the source of truth for the OS and Python matrix.requires_creds,linting,super_slowandflakymarkers, blanks GCP credentials and also runs on forks. A green run there therefore doesn't mean the credential tests passed.@pytest.mark.requires_creds, and never print secrets while debugging integrations.This PR changes docs only.
Link to Devin session: https://app.devin.ai/sessions/a144cb0b3f5447118290844c4cb27c80
Open in Devin Desktop: https://app.devin.ai/desktop/session/a144cb0b3f5447118290844c4cb27c80?variant=devin
Requested by: Aaron ("AJ") Steers (@aaronsteers)