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 installed in order to work
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 file.
| Package | Version | Description |
|---|---|---|
@codechecks/client |
 |
TypeScript/JavaScript client used for executing codechecks |
Note: Currently we are in the process of open sourcing whole platform.
Thanks goes to these wonderful people (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 specification. Contributions of any kind welcome! Read more!