CircleCI

Summary

This plugin collects various entities from CircleCI, including accounts, jobs, workflows, pipelines and projects.

Supported Versions

Check this doc for more details.

Entities

Check out the CircleCI entities collected by this plugin.

Metrics

Metrics that can be calculated based on the data collected from CircleCI:

• Build Count
• Build Duration
• Build Success Rate
• DORA - Deployment Frequency
• DORA - Lead Time for Changes
• DORA - Median Time to Restore Service
• DORA - Change Failure Rate

Configuration

• Configuring CircleCI via Config UI

API Sample Request

Note: Please replace the http://localhost:8080 in the sample requests with your actual DevLake API endpoint. For how to view DevLake API's swagger documentation, please refer to the "Using DevLake API" section of Developer Setup.

You can trigger data collection by making a POST request to /pipelines.

curl 'http://localhost:8080/pipelines' \
--header 'Content-Type: application/json' \
--data-raw '
{
  "name": "project1",
  "plan": [
    [
      {
        "plugin": "circleci",
        "options": {
          "connectionId": 1,
          "fullName": "likyh/likyhphp",
          "transformationRules":{
            "deploymentPattern":"",
            "productionPattern":"",
            "issueStatusTodo":"new,open",
            "issueStatusInProgress":"",
            "issueStatusDone":"resolved,closed",
            "issueStatusOther":"on hold,wontfix,duplicate,invalid"
          }
        }
      }
    ]
  ]
}
'

References

• references