https://github.com/codechecks/monorepo
Open source platform for code review automation ✅
https://github.com/codechecks/monorepo
check ci codechecks continuous-integration pull-request review
Last synced: 11 months ago
JSON representation
Open source platform for code review automation ✅
- Host: GitHub
- URL: https://github.com/codechecks/monorepo
- Owner: codechecks
- Created: 2019-06-30T16:36:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-11-28T07:14:11.000Z (about 4 years ago)
- Last Synced: 2025-03-30T18:11:06.813Z (11 months ago)
- Topics: check, ci, codechecks, continuous-integration, pull-request, review
- Language: TypeScript
- Homepage: https://codechecks.io/
- Size: 7.59 MB
- Stars: 99
- Watchers: 6
- Forks: 15
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
Code Checks
Open source platform for code review automation ✅
**CodeChecks.io** is a framework for code review automation. It allows writing plugins (codechecks) in **JavaScript**
that:
- execute directly on your **CI** (like CircleCI or TravisCI) and communicate with our backend
- can inspect all **Pull Request** data (title, content, changed files etc.)
- can attach feedback information back to **GitHub** as check (success/failure status, additional message)
- can upload, retrieve and calculate difference between arbitrary **artifacts** (like JSON values describing build size
or screenshots of views of a frontend app)
- require only one **GitHub App** — [Codechecks App](https://github.com/apps/codechecks) installed in order to work
```typescript
import { codechecks } from "@codechecks/client";
export default async () => {
await codechecks.success({
name: "Hello world!",
shortDescription: "It's so easy!",
longDescription: "# Hello! 👋",
});
};
```
Particular codechecks can be distributed as **npm** packages and can be setup in a declarative way in
[`codechecks.yml`](https://github.com/codechecks/docs/blob/master/configuration.md#codechecksyml) file.
## Docs 📚
- [Awesome codechecks](https://github.com/codechecks/awesome-codechecks)
- [Getting started guide](https://github.com/codechecks/docs/blob/master/getting-started.md)
- [Full documentation](https://github.com/codechecks/docs)
## Packages 📦
| Package | Version | Description |
| ---------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| [`@codechecks/client`](/packages/client) | [](https://www.npmjs.com/package/@codechecks/client) | TypeScript/JavaScript client used for executing codechecks |
Note: Currently we are in the process of open sourcing whole platform.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Chris Kaczor
💻 🤔 📖 💼 🚇
cgewecke
🔌 🤔 💻
Evgeniy Timokhov
🔌
Michał Załęcki
💻 🔌
Craig Thompson
💻
Jakub Ziółkowski
💻 🔌
Deric Cain
💻
Sean Dawson
🔌
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome! [Read more](./CONTRIBUTING.md)!