Skip to content

Commit

Permalink
Add Jenkins source from Faros AI to connector catalog (#9929)
Browse files Browse the repository at this point in the history
* Add Jenkins source from Faros AI to connector catalog

* todos

* Add setup instruction

* Update doc

* Feedback and add to dropdown

Co-authored-by: Chris Wu <chris@faros.ai>
  • Loading branch information
harshithmullapudi and cjwooo committed Feb 2, 2022
1 parent 51af69b commit f4365c5
Show file tree
Hide file tree
Showing 6 changed files with 153 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"sourceDefinitionId": "d6f73702-d7a0-4e95-9758-b0fb1af0bfba",
"name": "Jenkins",
"dockerRepository": "farosai/airbyte-jenkins-source",
"dockerImageTag": "0.1.23",
"documentationUrl": "https://docs.airbyte.io/integrations/sources/jenkins",
"icon": "jenkins.svg"
}
72 changes: 72 additions & 0 deletions airbyte-config/init/src/main/resources/icons/jenkins.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,13 @@
documentationUrl: https://docs.airbyte.io/integrations/sources/iterable
icon: iterable.svg
sourceType: api
- name: Jenkins
sourceDefinitionId: d6f73702-d7a0-4e95-9758-b0fb1af0bfba
dockerRepository: farosai/airbyte-jenkins-source
dockerImageTag: 0.1.23
documentationUrl: https://docs.airbyte.io/integrations/sources/jenkins
icon: jenkins.svg
sourceType: api
- name: Jira
sourceDefinitionId: 68e63de2-bb83-4c7e-93fa-a8a9051e3993
dockerRepository: airbyte/source-jira
Expand Down
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@
* [Instagram](integrations/sources/instagram.md)
* [Intercom](integrations/sources/intercom.md)
* [Iterable](integrations/sources/iterable.md)
* [Jenkins (Sponsored by Faros AI)](integrations/sources/jenkins.md)
* [Jira](integrations/sources/jira.md)
* [Kafka](integrations/sources/kafka.md)
* [Klaviyo](integrations/sources/klaviyo.md)
Expand Down
1 change: 1 addition & 0 deletions docs/integrations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Airbyte uses a grading system for connectors to help users understand what to ex
| [Instagram](sources/instagram.md) | Certified |
| [Intercom](sources/intercom.md) | Beta |
| [Iterable](sources/iterable.md) | Beta |
| [Jenkins](sources/jenkins.md) | Alpha |
| [Jira](sources/jira.md) | Certified |
| [Klaviyo](sources/klaviyo.md) | Beta |
| [Kustomer](sources/kustomer.md) | Alpha |
Expand Down
64 changes: 64 additions & 0 deletions docs/integrations/sources/jenkins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Jenkins

## Overview

The Jenkins source is maintained by [Faros
AI](https://github.com/faros-ai/airbyte-connectors/tree/main/sources/jenkins-source).
Please file any support requests on that repo to minimize response time from the
maintainers. The source supports both Full Refresh and Incremental syncs. You
can choose if this source will copy only the new or updated data, or all rows
in the tables and columns you set up for replication, every time a sync is run.

### Output schema

Several output streams are available from this source:

* [Builds](https://your.jenkins.url/job/$JOB_NAME/$BUILD_NUMBER/api/json?pretty=true) \(Incremental\)
* [Jobs](https://your.jenkins.url/job/$JOB_NAME/api/json?pretty=true)

In the above links, replace `your.jenkins.url` with the url of your Jenkins
instance, and replace any environment variables with an existing Jenkins job or
build id.

If there are more endpoints you'd like Faros AI to support, please [create an
issue.](https://github.com/faros-ai/airbyte-connectors/issues/new)

### Features

| Feature | Supported? |
| :--- | :--- |
| Full Refresh Sync | Yes |
| Incremental Sync | Yes |
| SSL connection | Yes |
| Namespaces | No |

### Performance considerations

The Jenkins source should not run into Jenkins API limitations under normal
usage. Please [create an
issue](https://github.com/faros-ai/airbyte-connectors/issues/new) if you see any
rate limit issues that are not automatically retried successfully.

## Getting started

### Requirements

* Jenkins Server
* Jenkins User
* Jenkins API Token

### Setup guide

Login to your Jenkins server in your browser and go to
`https://your.jenkins.url/me/configure` to generate your API token.

## Changelog

| Version | Date | Pull Request | Subject |
| :--- | :--- | :--- | :--- |
| 0.1.23 | 2021-10-01 | [114](https://github.com/faros-ai/airbyte-connectors/pull/114) | Added projects stream to Phabricator + cleanup |
| 0.1.22 | 2021-10-01 | [113](https://github.com/faros-ai/airbyte-connectors/pull/113) | Added revisions & users streams to Phabricator source + bump version |
| 0.1.21 | 2021-09-27 | [101](https://github.com/faros-ai/airbyte-connectors/pull/101) | Exclude tests from Docker + fix path + bump version |
| 0.1.20 | 2021-09-27 | [100](https://github.com/faros-ai/airbyte-connectors/pull/100) | Update Jenkins spec + refactor + add Phabricator source skeleton |
| 0.1.7 | 2021-09-25 | [64](https://github.com/faros-ai/airbyte-connectors/pull/64) | Add Jenkins source |

0 comments on commit f4365c5

Please sign in to comment.