Circleci [ARCHIVED]
This directory contains the manifest-only connector for source-circleci
.
Documentation reference:
- Visit
https://circleci.com/docs/api/v1/index.html
for V1 API documentation
- Visit
https://circleci.com/docs/api/v2/index.html
for V2 API documentation
Authentication setup
CircleCI
uses api key authentication, Visit https://app.circleci.com/settings/user/tokens
for getting your api keys.
Configuration
Input | Type | Description | Default Value |
---|
api_key | string | API Key. | |
org_id | string | Organization ID. The org ID found in https://app.circleci.com/settings/organization/circleci/xxxxx/overview | |
start_date | string | Start date. | |
project_id | string | Project ID found in the project settings. | |
job_id | string | Job ID for fetching information found in URL. | |
workflow_id | string | Workflow ID of a project pipeline. | |
workflow_name | string | Workflow name for fetching information. | |
job_number | string | Job Number of the workflow. | 2 |
Streams
Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
---|
context | id | DefaultPaginator | ✅ | ✅ |
self_ids | id | DefaultPaginator | ✅ | ❌ |
self_collaborations | id | DefaultPaginator | ✅ | ❌ |
me | analytics_id | DefaultPaginator | ✅ | ✅ |
projects | vcs_url | DefaultPaginator | ✅ | ❌ |
pipelines | id | DefaultPaginator | ✅ | ✅ |
specific_project | id | DefaultPaginator | ✅ | ❌ |
jobs | number | DefaultPaginator | ✅ | ❌ |
workflow | id | DefaultPaginator | ✅ | ✅ |
insights_metrics | project_id | DefaultPaginator | ✅ | ❌ |
insights_branches | id | DefaultPaginator | ✅ | ❌ |
workflow_jobs | id | DefaultPaginator | ✅ | ✅ |
Changelog
Expand to review
Version | Date | PR | Subject |
---|
0.0.1 | 2024-09-29 | 46249 | Initial release by @btkcodedev via Connector Builder |