GitHub Documents Ingestion Source Not Found Error and CLI Version Requirements – DataHub Customer Support Portal

Area: Ingestion Issues

Sub-Area: Source Plugin Recognition / CLI Version Compatibility

Issue

When attempting to configure and run a GitHub Documents ingestion recipe using the github-documents source type, DataHub may return a "source not found" or unrecognized plugin error. This typically occurs when the DataHub CLI version in use predates the introduction of the github-documents source plugin, meaning the plugin is not bundled with or recognized by the installed version of acryl-datahub.

Error Messages

Plugin 'github-documents' could not be found. Please ensure it is installed.
Source type 'github-documents' is not recognized.
No plugin found for source type: github-documents

You Might Be Asking

Why does my DataHub ingestion recipe fail with a "source not found" error when using github-documents?
Which version of the DataHub CLI introduced support for the github-documents ingestion source?
How do I upgrade the DataHub CLI to use the GitHub Documents ingestion source?
Do I need to install a separate plugin package for github-documents?

Solution

Verify your current DataHub CLI version:
```
datahub version
```
Check that the version returned supports the github-documents source. This source type was introduced in more recent releases of acryl-datahub. Consult the DataHub CLI changelog to confirm the minimum required version for your use case.
Upgrade the DataHub CLI to the latest version:
```
pip install --upgrade acryl-datahub
```
After upgrading, confirm the new version:
```
datahub version
```
Install the GitHub Documents plugin explicitly (if required):
In some configurations, the source plugin must be installed as an extras package:
```
pip install 'acryl-datahub[github]'
```
Verify the plugin is recognized after installation:
```
datahub check plugins
```
Look for github-documents in the list of available source plugins. If it appears, the installation was successful.

Configure your ingestion recipe using the correct source type:

source:
  type: github-documents
  config:
    github_token: <your-github-personal-access-token>
    owner: <your-github-org-or-user>
    repo: <your-repository-name>
    branch: main
    repo_path_exclude_regex: []

sink:
  type: datahub-rest
  config:
    server: "http://<your-datahub-gms-host>:8080"

Run the ingestion recipe:

datahub ingest -c <your-recipe-file>.yml

Additional Notes

The github-documents source plugin is designed to ingest documentation files (e.g., Markdown, reStructuredText) from GitHub repositories into DataHub as documentation entities. Because this is a relatively newer source type, older versions of acryl-datahub will not recognize it, and the ingestion will fail at plugin resolution time before any network calls are made. Always ensure that the CLI version used in your ingestion environment — whether local, containerized, or managed — matches or exceeds the minimum version required for the plugins you intend to use. If you are running ingestion via the DataHub UI's managed ingestion feature, verify that the executor's CLI version is also up to date.

Issue

Error Messages

You Might Be Asking

Solution

Additional Notes

Related Documentation