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

Source Mailchimp: update documentation #11352

Merged
merged 16 commits into from
Apr 21, 2022
Merged

Conversation

annalvova05
Copy link
Contributor

@annalvova05 annalvova05 commented Mar 23, 2022

What

Close #11347

How

Update documentation
mailchimp_doc1

Recommended reading order

  1. spec.json
  2. mailchimp.md

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • 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.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

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.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the new connector version is published, connector version bumped in the seed directory as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@annalvova05 annalvova05 self-assigned this Mar 23, 2022
@github-actions github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Mar 23, 2022
@codecov
Copy link

codecov bot commented Mar 23, 2022

Codecov Report

❗ No coverage uploaded for pull request base (master@1f2fdae). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head 742b78f differs from pull request most recent head 73ec29f. Consider uploading reports for the commit 73ec29f to get more accurate results

@@            Coverage Diff            @@
##             master   #11352   +/-   ##
=========================================
  Coverage          ?   94.66%           
=========================================
  Files             ?        3           
  Lines             ?      150           
  Branches          ?        0           
=========================================
  Hits              ?      142           
  Misses            ?        8           
  Partials          ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1f2fdae...73ec29f. Read the comment docs.

Copy link
Contributor

@misteryeo misteryeo left a comment

Choose a reason for hiding this comment

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

Added a few comments and feedback.

FYI @andyjih

docs/integrations/sources/mailchimp.md Outdated Show resolved Hide resolved
docs/integrations/sources/mailchimp.md Outdated Show resolved Hide resolved
docs/integrations/sources/mailchimp.md Outdated Show resolved Hide resolved
docs/integrations/sources/mailchimp.md Outdated Show resolved Hide resolved
docs/integrations/sources/mailchimp.md Outdated Show resolved Hide resolved
docs/integrations/sources/mailchimp.md Outdated Show resolved Hide resolved
docs/integrations/sources/mailchimp.md Outdated Show resolved Hide resolved
docs/integrations/sources/mailchimp.md Outdated Show resolved Hide resolved
annalvova05 and others added 7 commits April 19, 2022 14:44
Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Andy <andy@airbyte.io>
docs/integrations/sources/mailchimp.md Outdated Show resolved Hide resolved
@annalvova05
Copy link
Contributor Author

annalvova05 commented Apr 21, 2022

/test connector=connectors/source-mailchimp

🕑 connectors/source-mailchimp https://github.com/airbytehq/airbyte/actions/runs/2201354549
✅ connectors/source-mailchimp https://github.com/airbytehq/airbyte/actions/runs/2201354549
Python tests coverage:

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        74      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/utils/common.py                  80     17    79%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/tests/test_core.py              285    106    63%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
source_acceptance_test/tests/test_incremental.py        69     38    45%
------------------------------------------------------------------------
TOTAL                                                  896    259    71%
Name                           Stmts   Miss  Cover
--------------------------------------------------
source_mailchimp/__init__.py       2      0   100%
source_mailchimp/source.py        45      1    98%
source_mailchimp/streams.py      103      7    93%
--------------------------------------------------
TOTAL                            150      8    95%

Python short test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:56: Skipping TestIncremental.test_two_sequential_reads because not found in the config
================== 38 passed, 1 skipped in 722.32s (0:12:02) ===================

@annalvova05
Copy link
Contributor Author

annalvova05 commented Apr 21, 2022

/publish connector=connectors/source-mailchimp

🕑 connectors/source-mailchimp https://github.com/airbytehq/airbyte/actions/runs/2201469798
❌ Failed to publish connectors/source-mailchimp
❌ Couldn't auto-bump version for connectors/source-mailchimp

@annalvova05
Copy link
Contributor Author

annalvova05 commented Apr 21, 2022

/publish connector=connectors/source-mailchimp

🕑 connectors/source-mailchimp https://github.com/airbytehq/airbyte/actions/runs/2201537249
🚀 Successfully published connectors/source-mailchimp
🚀 Auto-bumped version for connectors/source-mailchimp
✅ connectors/source-mailchimp https://github.com/airbytehq/airbyte/actions/runs/2201537249

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets April 21, 2022 11:55 Inactive
@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets April 21, 2022 11:55 Inactive
@annalvova05 annalvova05 merged commit 9bfc21f into master Apr 21, 2022
@annalvova05 annalvova05 deleted the alvova/11347-mailchimp-docs branch April 21, 2022 11:56
suhomud pushed a commit that referenced this pull request May 23, 2022
* update doc

* bump version

* upd doc

* update doc

* Update docs/integrations/sources/mailchimp.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/integrations/sources/mailchimp.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/integrations/sources/mailchimp.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/integrations/sources/mailchimp.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/integrations/sources/mailchimp.md

Co-authored-by: Andy <andy@airbyte.io>

* Update docs/integrations/sources/mailchimp.md

Co-authored-by: Andy <andy@airbyte.io>

* update doc

* Update docs/integrations/sources/mailchimp.md

Co-authored-by: Andy <andy@airbyte.io>

* auto-bump connector version

Co-authored-by: Andy <andy@airbyte.io>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Source Mailchimp: update documentation
4 participants