Skip to content

boyney123/status-checks

Repository files navigation

status-checks: GitHub status checks as JS functions.

Quickly get setup and integrate with GitHub status checks. You provide the functions and we will do the rest.


Travis CodeCov MIT License PRs Welcome

Watch on GitHub Star on GitHub Tweet

Donate ☕


header

Features: GitHub integration, functions, docker support, exposed GitHub API helpers, setup within minutes, easily host and more...

Read the Docs | Edit the Docs


The problem

Code quality is important. To help with code quality we have various tasks / scripts / apps and bots that we need to run to assert our quality does not drop.

Continuous integration is a great way to make sure our quality does not drop and we have confidence with our software.

GitHub have done a great job allowing us to integrate with the platform and run various checks before code gets merged. You can automate these checks with GitHub using status checks and GitHub actions.

In the past I have setup multiple projects with GitHub to integrate and run various commands through status checks, and I wanted to create an application that could handle most the integration for me. I wanted to create a platform that allowed me to specify the functions I want to run on each status check.

This is when status-checks was born. status-checks takes a folder of functions (defined by you) and runs them through any pull request that comes in and integrated back with GitHub.

You can read the documentation on how to get started.

This solution

status-checks was built and designed to help developers integrate with GitHub status checks easier. You define the functions to run and this project will do the rest.

Documentation

⭐ Huge thanks to the all-contributors project for allowing us to use their theme for the documentation website. ⭐

Tools

Testing

Contributing

If you have any questions, features or issues please raise any issue or pull requests you like.

Donating

If you find this tool useful, feel free to buy me a ☕ 👍

Buy a drink

License

MIT.