The tap-github
extractor
pulls data from
GitHub that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
Alternate Implementations
- Airbyte
🥈
- Meltano (default)
- Stitch Data🥈
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-github extractor to your
project using
:meltano add -
Configure the tap-github
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-github --variant airbytemeltano config tap-github set --interactivemeltano config tap-github testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-github
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-github settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
airbyte_config.branchairbyte_config.credentials.access_tokenairbyte_config.credentials.option_titleairbyte_config.credentials.personal_access_tokenairbyte_config.page_size_for_large_streamsairbyte_config.repositoryairbyte_config.start_dateairbyte_spec.imageairbyte_spec.tagdocker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-github list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Airbyte Config Branch (airbyte_config.branch)
-
Environment variable:
TAP_GITHUB_AIRBYTE_CONFIG_BRANCH
Space-delimited list of GitHub repository branches to pull commits for, e.g. airbytehq/airbyte/master. If no branches are specified for a repository, the default branch will be pulled.
Configure this setting directly using the following Meltano command:
meltano config tap-github set airbyte_config branch [value]Airbyte Config Credentials Access Token (airbyte_config.credentials.access_token)
-
Environment variable:
TAP_GITHUB_AIRBYTE_CONFIG_CREDENTIALS_ACCESS_TOKEN
OAuth access token
Configure this setting directly using the following Meltano command:
meltano config tap-github set airbyte_config credentials.access_token [value]Airbyte Config Credentials Option Title (airbyte_config.credentials.option_title)
-
Environment variable:
TAP_GITHUB_AIRBYTE_CONFIG_CREDENTIALS_OPTION_TITLE
OAuth Credentials, PAT Credentials
Configure this setting directly using the following Meltano command:
meltano config tap-github set airbyte_config credentials.option_title [value]Airbyte Config Credentials Personal Access Token (airbyte_config.credentials.personal_access_token)
-
Environment variable:
TAP_GITHUB_AIRBYTE_CONFIG_CREDENTIALS_PERSONAL_ACCESS_TOKEN
Log into GitHub and then generate a personal access token. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with ","
Configure this setting directly using the following Meltano command:
meltano config tap-github set airbyte_config credentials.personal_access_token [value]Airbyte Config Page Size For Large Streams (airbyte_config.page_size_for_large_streams)
-
Environment variable:
TAP_GITHUB_AIRBYTE_CONFIG_PAGE_SIZE_FOR_LARGE_STREAMS
The Github connector contains several streams with a large amount of data. The page size of such streams depends on the size of your repository. We recommended that you specify values between 10 and 30.
Configure this setting directly using the following Meltano command:
meltano config tap-github set airbyte_config page_size_for_large_streams [value]Airbyte Config Repository (airbyte_config.repository)
-
Environment variable:
TAP_GITHUB_AIRBYTE_CONFIG_REPOSITORY
Space-delimited list of GitHub organizations/repositories, e.g. airbytehq/airbyte for single repository, airbytehq/* for get all repositories from organization and airbytehq/airbyte airbytehq/another-repo for multiple repositories.
Configure this setting directly using the following Meltano command:
meltano config tap-github set airbyte_config repository [value]Airbyte Config Start Date (airbyte_config.start_date)
-
Environment variable:
TAP_GITHUB_AIRBYTE_CONFIG_START_DATE
The date from which you'd like to replicate data from GitHub in the format YYYY-MM-DDT00:00:00Z. For the streams which support this configuration, only data generated on or after the start date will be replicated. This field doesn't apply to all streams, see the docs for more info
Configure this setting directly using the following Meltano command:
meltano config tap-github set airbyte_config start_date [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_GITHUB_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-github
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-github set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_GITHUB_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-github set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_GITHUB_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-github set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_GITHUB_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-github set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_GITHUB_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-github set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_GITHUB_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-github set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_GITHUB_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-github set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-yellow){kind=icon}
-1-c0c0c4){kind=icon}
