Light

boyney123 / status-checks Goto Github PK

View Code? Open in Web Editor NEW

34.0 3.0 1.0 926 KB

GitHub status checks as Functions

Home Page: https://status-checks.netlify.com/

License: MIT License

Dockerfile 1.40% JavaScript 96.80% Shell 1.81%

github status-checks javascript continous-integration

status-checks's Introduction

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.

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

jest

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 ☕ 👍

License

MIT.

status-checks's People

Contributors

Stargazers

Watchers

Forkers

status-checks's Issues

Ability to set what the trigger for the status-check task is

So currently the status check will refire with every action that is performed on the PR. The same for if you add a commit or update the title for example.

It would be nice if you could set in the metadata of each task what trigger you want this task to respond to.

For example if you have an NPM test status check, you could want that to trigger on every commit, but you probably wouldn't want to re run your tests if you just updated the title of the PR or added a label.

Option for caching a clone of the project or flag to set if no clone of the project is required.

Not all status checks might need a clone of the project, if you just checking something on the payload of the PR then it would be nice for it not have to clone the whole project. If you do have to clone the project then cache it for 30mins or something to speed it up next time?

An API to perform quick actions on the PR

Would be pretty cool if you got a few things out the box to enrich the task experience with the PR.

For example if you could import a set of functions that let you:

Create comments on the PR
Update the Title
Add labels
Remove labels
Request reviewers
Approve, Block, Merge etc...

Build and write docs for Docker support

At the moment people have to clone the project and install it etc.

Would be nice to also have Docker support.

Idea is:

Use the docker image to do everything
Give the docker image the token and secret
Mount a volume of tasks to the container
Profit

Remove the need for the status-check app status on the PR

Maybe we could move this feedback of what state the status-check app is in, on to the particular task that is running. Removing the need to introduce a new status check just for the app running in the background?

The ability to run a single install of status-checks across multiple repos

It would be nice to run a single installation of status-checks across multiple repos. As a dev team that look after projects across a number of repos, this would save us installing and managing many instances of this project. Especially if you wanted to run the same check on them all as well.

Maybe something for the manifest.json file?

Create new logo for project

Currently using all-contributors template for the website, with that comes their logo.

I would like to replace the logo with a new one if anybody has any ideas or would like to contribute feel free.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.