{"id":17117802,"url":"https://github.com/anderspitman/quarantest","last_synced_at":"2025-06-27T21:34:24.110Z","repository":{"id":81835915,"uuid":"248624883","full_name":"anderspitman/quarantest","owner":"anderspitman","description":"Isolated human-testable frontend builds for every pull request","archived":false,"fork":false,"pushed_at":"2020-06-18T23:05:29.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-21T04:18:36.186Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anderspitman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-19T23:23:01.000Z","updated_at":"2020-06-21T21:58:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"87111c9d-9495-4dd5-88fb-5c677190d4fb","html_url":"https://github.com/anderspitman/quarantest","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/anderspitman/quarantest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anderspitman%2Fquarantest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anderspitman%2Fquarantest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anderspitman%2Fquarantest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anderspitman%2Fquarantest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anderspitman","download_url":"https://codeload.github.com/anderspitman/quarantest/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anderspitman%2Fquarantest/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262335492,"owners_count":23295663,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T17:52:43.528Z","updated_at":"2025-06-27T21:34:24.071Z","avatar_url":"https://github.com/anderspitman.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"Most CI testing tools focus on automated tests, but sometimes the changes are\nvery visual and you just want to give your team a demo of your pull request to\nplay with. quarantest runs a build for each GitHub PR, generates a URL for the\nbuild, then posts a comment on the PR with a link to the build. You can see an\nexample of it in action [here][0]. Still in a pretty hacky state. Probably would\nbe better to use the GH status API with a link that goes to a page listing all\nthe past builds from the PR instead of spamming comments, but it's getting the\njob done.\n\n# How to use it\n\nThere are 3 steps to using quarantest:\n\n1. Setting up the server process\n2. Setting up the project repo\n3. Pointing GitHub webhooks at the server\n\n\n# Setting up the server\n\nquarantest is a single binary. Simply run it on a publicly addressible server.\nYou'll also need a wildcard domain registration set up, as quarantest using\ndomains based of commit hashes. Running behind an HTTPS proxy is recommended\nbut not required.\n\nYou'll also need a `github_credentials.json` file in the working directory\nfor quarantest, for posting comments. It looks like this:\n\n```json\n{\n  \"username\": \"anderspitman\",\n  \"token\": \"****************************\"\n}\n```\n\n# Setting up the project repo\n\nPut a `quarantest.json` file in the root of the GitHub\nrepo for a frontend app you want to test. The file looks like this:\n\n```json\n{\n  \"build_script\": \"quarantest_build.sh\",\n  \"docker_image\": \"anderspitman/iobio-nodejs-12\"\n}\n```\n\nYou can see that it references a build script and a Docker image. The build\nscript is what quarantest uses to build the project whenever a webhook is\nreceived. The key thing to know is that the script expects to run inside a\nDocker image where `/src` contains the repo code and `/build` is where the\noutput of the build goes. The Docker image doesn't have to be set up in any\nspecial way. It just needs to have all the necessary build dependencies\ninstalled. `/src` and `/build` are mounted automatically by quarantest.\n\nHere's an example build script:\n\n```bash\n#!/bin/bash\n\ncd /src\nnpm install\nnpm run build\ncp -a * /build/\n```\n\nHere's another one for a very simple app that's just an index.html and\nmain.js, with no complicated build step:\n\n```/bash\ncp /src/* /build/*\n```\n\nquarantest will automatically download whatever Docker image you specify in\neach repo.\n\nYou can find a real-world example in the gene.iobio repo [here][1].\n\n\n# Set up the webhooks\n\nFinally, you just need to point the GitHub webhooks at the `/webhook` endpoint\nof the quarantest server.\n\n\n[0]: https://github.com/iobio/gene.iobio.vue/pull/497 \n\n[1]: https://github.com/iobio/gene.iobio.vue\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanderspitman%2Fquarantest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanderspitman%2Fquarantest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanderspitman%2Fquarantest/lists"}