0.1.5 • Published 4 years ago
@canvanauts/check-a-block v0.1.5
check-a-block
chock-a-block
/tʃɒkəˈblɒk/
adjective INFORMAL•BRITISH
crammed full of people or things.
"the manual is chock-a-block with information"
A Github app that reads a checkstyle-formatted file and annotates the issues on a Github PR using the Checks API.
This repo contains the Node.js Typescript source code for the app. The app should be built/installed and run on a command line. It authenticates as the accompanying check-a-block Github app, and then interacts with the checks API.
Design overview document (Google docs)
Github permissions
The check-a-block Github app must be installed by the user/org wishing to use it. It must have access to the intended repos with permission to:
- Read/Write checks
- Read Pull requests (optional - required for adding checks for a given PR instead of a commit directly)
Future goals
- Add conversion of other error-list formats (eg. Junit)
- (Possibly) Improve app entrypoints for use in environments other than just the Canva web build pipeline.