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

[do not merge] test code freeze workflow #33671

Conversation

alafanechere
Copy link
Contributor

What

Describe what the change is solving
It helps to add screenshots if it affects the frontend.

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Connector version is set to 0.0.1
    • Dockerfile has version 0.0.1
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
    • docs/integrations/README.md

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:generateScaffolds then checking in your changes
  • Documentation which references the generator is updated as needed
Updating the Python CDK

Airbyter

Before merging:

  • Pull Request description explains what problem it is solving
  • Code change is unit tested
  • Build and my-py check pass
  • Smoke test the change on at least one affected connector
    • On Github: Run this workflow, passing --use-local-cdk --name=source-<connector> as options
    • Locally: airbyte-ci connectors --use-local-cdk --name=source-<connector> test
  • PR is reviewed and approved

After merging:

  • Publish the CDK
    • The CDK does not follow proper semantic versioning. Choose minor if this the change has significant user impact or is a breaking change. Choose patch otherwise.
    • Write a thoughtful changelog message so we know what was updated.
  • Merge the platform PR that was auto-created for updating the Connector Builder's CDK version
    • This step is optional if the change does not affect the connector builder or declarative connectors.

Copy link

vercel bot commented Dec 20, 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 Dec 20, 2023 10:11am

Copy link
Contributor

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.

@alafanechere alafanechere force-pushed the augustin/12-20-_do_not_merge_test_code_freeze_workflow branch from 1d2e985 to fe0f871 Compare December 20, 2023 08:47
@alafanechere alafanechere changed the base branch from master to augustin/12-20-fix_code_freeze_workflow December 20, 2023 08:47
Copy link
Contributor Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

Current dependencies on/for this PR:

This stack of pull requests is managed by Graphite.

@alafanechere alafanechere force-pushed the augustin/12-20-fix_code_freeze_workflow branch from 66e6a3f to ece3a5a Compare December 20, 2023 08:52
@alafanechere alafanechere force-pushed the augustin/12-20-_do_not_merge_test_code_freeze_workflow branch 12 times, most recently from e00355c to d7a72e0 Compare December 20, 2023 09:29
Copy link
Contributor

github-actions bot commented Dec 20, 2023

Warning

🚨 Connector code freeze is in effect until 2024-01-02. This PR is changing connector code. Please contact the current OC engineers if you want to merge this change to master.

@airbytehq airbytehq deleted a comment from github-actions bot Dec 20, 2023
@octavia-squidington-iii octavia-squidington-iii removed the area/connectors Connector related issues label Dec 20, 2023
@alafanechere alafanechere force-pushed the augustin/12-20-_do_not_merge_test_code_freeze_workflow branch 3 times, most recently from 9a70fe7 to 317307e Compare December 20, 2023 09:41
@alafanechere alafanechere force-pushed the augustin/12-20-fix_code_freeze_workflow branch from 11c43ac to 2b56f9b Compare December 20, 2023 09:43
@alafanechere alafanechere force-pushed the augustin/12-20-_do_not_merge_test_code_freeze_workflow branch 2 times, most recently from 9c76c7d to 9a2157d Compare December 20, 2023 09:54
@alafanechere alafanechere force-pushed the augustin/12-20-fix_code_freeze_workflow branch from c31714b to f287b39 Compare December 20, 2023 09:55
@alafanechere alafanechere force-pushed the augustin/12-20-_do_not_merge_test_code_freeze_workflow branch 2 times, most recently from fbdbe6a to c700a0b Compare December 20, 2023 09:57
@octavia-squidington-iii octavia-squidington-iii added the area/connectors Connector related issues label Dec 20, 2023
@alafanechere alafanechere force-pushed the augustin/12-20-fix_code_freeze_workflow branch from cb00ea6 to 2f82128 Compare December 20, 2023 10:10
@alafanechere alafanechere force-pushed the augustin/12-20-_do_not_merge_test_code_freeze_workflow branch from d5f80c5 to 4dcc34c Compare December 20, 2023 10:11
@octavia-squidington-iii octavia-squidington-iii removed the area/connectors Connector related issues label Dec 20, 2023
Base automatically changed from augustin/12-20-fix_code_freeze_workflow to master December 20, 2023 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants