Lib.rs

qvet

Quickly vet your releases for QA.

Overview

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

Permissions

• 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

Development

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 0.0.0.0:3000'

NOTE

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.

Docker

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 0.0.0.0:39105

Environment variables