#github #ci #qa #app #back-end #qvet

bin+lib qvet-api

Backend api implementation for qvet

3 releases

0.1.2 Feb 3, 2023
0.1.1 Feb 2, 2023
0.1.0 Feb 2, 2023

#617 in Testing

Used in qvet-standalone

MIT license

222 lines


Quickly vet your releases for QA.


qvet homepage screenshot

qvet has two main components:

  • web: The shiny dashboard UI. Most functionality is here.
  • api: A lightweight backend, used where secrets are required.

All data is stored in Github, there is no additional persistent store/database required.

Github App Configuration


  • Commit statuses: Read and Write
    • To read and set QA status
  • Contents: Read only
    • To read branches, commits and tags

Events (currently not required)

  • Create
    • To listen for a new tag (release) being created
  • Push
    • To listen for new commits being pushed to master
  • Status
    • To listen for QA statuses being updated


Start the two services in development/hot reload mode. Respectively:

  • web with cd qvet-web && npm install && npm run dev
  • api with cd qvet-api && cargo watch -x 'run -- --bind'


You'll need to make sure that http://localhost is mapped to an IPv4 address. If it isn't, then the webapp won't be able to resolve the API correctly.

Check /etc/hosts for any keys that map to localhost.

Standalone deployment

For convenience, qvet can run bundled in a single binary.


For convenience, this binary is available in a thin docker image wrapper.

To build a new release, run ./qvet-standalone/scripts/build.sh, which will produce an image named qvet-standalone.

This can then be invoked as follows:

docker run -d --rm --name ci-qvet --init -e GITHUB_CLIENT_ID -e GITHUB_CLIENT_SECRET -e QVET_COOKIE_KEY -p 39106:39105 qvet-standalone --bind

Environment variables

Environment Variable Example Purpose Notes
GITHUB_CLIENT_ID Iv1.0123456789abcdef Github App Client Id Required
GITHUB_CLIENT_SECRET random hexadecimal, 40 characters Github App Client Secret Required
QVET_COOKIE_KEY random hexadecimal, 64 characters qvet private cookie encryption Optional. If unset, a random key will be generated at runtime.


~487K SLoC