🐛 Source Github: improve docs & spec for BETA #11212

grubberr · 2022-03-16T21:58:53Z

Signed-off-by: Sergey Chvalyuk grubberr@gmail.com

What

Refine and improve docs & spec for Beta

How

Improve incorrect message that start date only supported for 3 streams, for now start_date supported for 17 streams.
Sort streams name alphabetically
Move some incremental streams from Full refresh to Incremental section
replace old oauth2.0 specification authSpecification -> to new advanced_auth
Re-order spec fields

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

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

codecov · 2022-03-16T22:09:00Z

Codecov Report

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

❗ Current head a4d2564 differs from pull request most recent head 3c2fd78. Consider uploading reports for the commit 3c2fd78 to get more accurate results

@@            Coverage Diff            @@
##             master   #11212   +/-   ##
=========================================
  Coverage          ?   89.54%           
=========================================
  Files             ?        3           
  Lines             ?      555           
  Branches          ?        0           
=========================================
  Hits              ?      497           
  Misses            ?       58           
  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 6528926...3c2fd78. Read the comment docs.

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr · 2022-03-19T05:34:39Z

/test connector=connectors/github-source

🕑 connectors/github-source https://github.com/airbytehq/airbyte/actions/runs/2007743293
❌ connectors/github-source https://github.com/airbytehq/airbyte/actions/runs/2007743293
🐛

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr · 2022-03-19T11:26:56Z

/test connector=connectors/github-source

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

misteryeo

A few more changes based on conversation

airbyte-integrations/connectors/source-github/source_github/spec.json

docs/integrations/sources/github.md

airbyte-integrations/connectors/source-github/source_github/spec.json

docs/integrations/sources/github.md

…ec.json

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr · 2022-03-24T16:11:46Z

/test connector=connectors/source-github

🕑 connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/2035448283
✅ connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/2035448283
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                  70     17    76%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/tests/test_core.py              275    106    61%
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                                                  876    259    70%
Name                        Stmts   Miss  Cover
-----------------------------------------------
source_github/__init__.py       2      0   100%
source_github/streams.py      465     34    93%
source_github/source.py        89     24    73%
-----------------------------------------------
TOTAL                         556     58    90%

grubberr · 2022-03-24T16:18:04Z

/test connector=connectors/source-github

🕑 connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/2035496892
✅ connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/2035496892
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                  70     17    76%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/tests/test_core.py              275    106    61%
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                                                  876    259    70%
Name                        Stmts   Miss  Cover
-----------------------------------------------
source_github/__init__.py       2      0   100%
source_github/streams.py      465     34    93%
source_github/source.py        89     24    73%
-----------------------------------------------
TOTAL                         556     58    90%

grubberr · 2022-03-24T17:08:31Z

/publish connector=connectors/source-github

grubberr · 2022-03-24T18:39:13Z

/publish connector=connectors/source-github

grubberr · 2022-03-24T19:34:43Z

/publish connector=connectors/source-github

🕑 connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/2036243685
❌ connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/2036243685

grubberr · 2022-03-24T19:39:11Z

/publish connector=connectors/source-github

🕑 connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/2036263106
✅ connectors/source-github https://github.com/airbytehq/airbyte/actions/runs/2036263106

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

improve docs for BETA

5b90585

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr self-assigned this Mar 16, 2022

github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Mar 16, 2022

grubberr linked an issue Mar 16, 2022 that may be closed by this pull request

🐛 Source Github: improve docs & spec for BETA #11211

Closed

bump version 0.2.22 -> 0.2.23

a518b8e

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr temporarily deployed to more-secrets March 16, 2022 22:05 Inactive

grubberr changed the title ~~🐛 Source Github: improve docs for BETA~~ 🐛 Source Github: improve docs & spec for BETA Mar 17, 2022

improve changelog

a25713c

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr requested review from annalvova05 and lazebnyi March 17, 2022 06:37

grubberr temporarily deployed to more-secrets March 17, 2022 06:37 Inactive

Merge branch 'master' into grubberr/11211-source-github

f583faf

grubberr temporarily deployed to more-secrets March 18, 2022 18:02 Inactive

Merge branch 'master' into grubberr/11211-source-github

5b31b6a

grubberr temporarily deployed to more-secrets March 18, 2022 19:22 Inactive

grubberr added 2 commits March 19, 2022 07:32

Merge branch 'master' into grubberr/11211-source-github

97b66a3

authSpecification -> advanced_auth

be160fa

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr temporarily deployed to more-secrets March 19, 2022 05:35 Inactive

Merge branch 'master' into grubberr/11211-source-github

816774c

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr temporarily deployed to more-secrets March 19, 2022 11:27 Inactive

improve label for Authenticate via GitHub (OAuth)

049cabb

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr temporarily deployed to more-secrets March 23, 2022 15:36 Inactive

misteryeo suggested changes Mar 24, 2022

View reviewed changes

airbyte-integrations/connectors/source-github/source_github/spec.json Outdated Show resolved Hide resolved

airbyte-integrations/connectors/source-github/source_github/spec.json Show resolved Hide resolved

docs/integrations/sources/github.md Show resolved Hide resolved

sherifnada reviewed Mar 24, 2022

View reviewed changes

airbyte-integrations/connectors/source-github/source_github/spec.json Outdated Show resolved Hide resolved

docs/integrations/sources/github.md Outdated Show resolved Hide resolved

docs/integrations/sources/github.md Outdated Show resolved Hide resolved

sherifnada added 3 commits March 24, 2022 08:15

Update docs/integrations/sources/github.md

874d3a3

Update docs/integrations/sources/github.md

745b865

Update airbyte-integrations/connectors/source-github/source_github/sp…

8ed9edd

…ec.json

sherifnada requested a review from misteryeo March 24, 2022 15:17

sherifnada temporarily deployed to more-secrets March 24, 2022 15:18 Inactive

grubberr added 2 commits March 24, 2022 17:33

Merge branch 'master' into grubberr/11211-source-github

bd592a3

fix urls and quoting

a4d2564

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

misteryeo approved these changes Mar 24, 2022

View reviewed changes

grubberr temporarily deployed to more-secrets March 24, 2022 16:23 Inactive

source_specs.yaml updated

3c2fd78

Signed-off-by: Sergey Chvalyuk <grubberr@gmail.com>

grubberr merged commit 05605c6 into master Mar 24, 2022

grubberr deleted the grubberr/11211-source-github branch March 24, 2022 19:55

grubberr temporarily deployed to more-secrets March 24, 2022 19:57 Inactive

octavia-squidington-iii mentioned this pull request Mar 28, 2022

Bump Airbyte version from 0.35.60-alpha to 0.35.61-alpha #11478

Merged

lazebnyi removed their request for review May 30, 2022 10:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🐛 Source Github: improve docs & spec for BETA #11212

🐛 Source Github: improve docs & spec for BETA #11212

grubberr commented Mar 16, 2022 •

edited

Loading

codecov bot commented Mar 16, 2022 •

edited

Loading

grubberr commented Mar 19, 2022 •

edited by github-actions bot

Loading

grubberr commented Mar 19, 2022

misteryeo left a comment

grubberr commented Mar 24, 2022 •

edited by github-actions bot

Loading

grubberr commented Mar 24, 2022 •

edited by github-actions bot

Loading

grubberr commented Mar 24, 2022

grubberr commented Mar 24, 2022

grubberr commented Mar 24, 2022 •

edited by github-actions bot

Loading

grubberr commented Mar 24, 2022 •

edited by github-actions bot

Loading

🐛 Source Github: improve docs & spec for BETA #11212

🐛 Source Github: improve docs & spec for BETA #11212

Conversation

grubberr commented Mar 16, 2022 • edited Loading

What

How

Pre-merge Checklist

Community member or Airbyter

Airbyter

codecov bot commented Mar 16, 2022 • edited Loading

Codecov Report

grubberr commented Mar 19, 2022 • edited by github-actions bot Loading

grubberr commented Mar 19, 2022

misteryeo left a comment

Choose a reason for hiding this comment

grubberr commented Mar 24, 2022 • edited by github-actions bot Loading

grubberr commented Mar 24, 2022 • edited by github-actions bot Loading

grubberr commented Mar 24, 2022

grubberr commented Mar 24, 2022

grubberr commented Mar 24, 2022 • edited by github-actions bot Loading

grubberr commented Mar 24, 2022 • edited by github-actions bot Loading

grubberr commented Mar 16, 2022 •

edited

Loading

codecov bot commented Mar 16, 2022 •

edited

Loading

grubberr commented Mar 19, 2022 •

edited by github-actions bot

Loading

grubberr commented Mar 24, 2022 •

edited by github-actions bot

Loading

grubberr commented Mar 24, 2022 •

edited by github-actions bot

Loading

grubberr commented Mar 24, 2022 •

edited by github-actions bot

Loading

grubberr commented Mar 24, 2022 •

edited by github-actions bot

Loading