https://github.com/codeclimate/codeclimate-connector-circleci
Code Climate Connector for CircleCI
https://github.com/codeclimate/codeclimate-connector-circleci
engineering-data-platform velocity
Last synced: 11 months ago
JSON representation
Code Climate Connector for CircleCI
- Host: GitHub
- URL: https://github.com/codeclimate/codeclimate-connector-circleci
- Owner: codeclimate
- License: apache-2.0
- Created: 2020-03-04T17:35:04.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-05T00:49:50.000Z (almost 6 years ago)
- Last Synced: 2025-01-11T18:18:46.843Z (about 1 year ago)
- Topics: engineering-data-platform, velocity
- Language: TypeScript
- Homepage: https://github.com/codeclimate/platform
- Size: 143 KB
- Stars: 0
- Watchers: 13
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Code Climate Connector: CircleCI
A Code Climate Connector for [CircleCI](https://circleci.com).
## Configuration
Expects configuration of the following schema:
```json
{
"apiToken": "your_api_token"
}
```
If you are logged in to your CircleCI account, visit
https://circleci.com/account/api to create a token.
## Running the connector locally
To run the connector in an integration environment, the
[`codeclimate-connector-sdk`][sdk] provides a CLI you can use.
First write valid configuration to `connector-config.json`. Then, there are
several make rules to run different commands easily:
```
# Run this to check the correctness of your connector-config.json
make verify-configuration
# Run this to list your CirclCI projects as Streams
make discover-streams
# Run this to sync data from one of your projects. Write the contents of one of
# the Stream records emitted by discover-streams to stream.json
make sync-stream
```
[sdk]: https://github.com/codeclimate/codeclimate-connector-sdk
## Development
See [`DEVELOPERS.md`](DEVELOPERS.md)