Built-in CircleCI connector for CI logs

Open
#113 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
54/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python

Research direction

Start by reading the existing GitHub Actions connection and tools referenced by issue #69, then trace how connections apply output limits and store run artifacts. Implement the read-only CircleCI project tools with matching shapes where possible and cap job output at the last 300 lines. Validate against a CircleCI project with a known flaky test and confirm the report cites the failing log step.

Written by the indexing model from the issue text.

Description

area: connectors help wanted idea

Idea

Add CircleCI as a built-in connection, so ci-failure-review can read CircleCI pipelines and job logs.

Problem

ci-failure-review can read GitHub Actions runs and logs (#69). Teams that run CI on CircleCI get nothing built in and need a custom connection.

Proposed initial scope

  • A CircleCI connection with a read-only project API token for each chosen project.
  • Read tools only, as an allowlist: list pipelines and workflows for a project, get a workflow with its jobs, get a job's step output.
  • Job logs come back as text, capped like GitHub Actions logs (the last 300 lines).
  • Logs pass through the existing output limits and are never stored in plaintext beyond the run's artifacts.
  • Same tool shapes as the GitHub Actions tools where possible, so one skill can work with either.

Validation

Run ci-failure-review against a CircleCI project with a known flaky test and confirm the report cites the failing step from the log.

Split out from #54.

Dominant language
Python
Stars
1
Forks
1
Avg merge
1h 9m
Merged PRs (30d)
322

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from piotrekno1/second-shift

All issues in piotrekno1/second-shift

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.