README.md

In mrc-ide/pkgbuilder: Build Binary Packages

pkgbuilder

Installation

remotes::install_github("mrc-ide/pkgbuilder")

Usage

Bring up an API using

pkgbuilder::pb_server(c("3.6", "4.0"), "pb", 8080)

This will never return, but expose a server on port 8080

$ curl -s http://localhost:8080/ | jq
{
  "status": "success",
  "errors": null,
  "data": {
    "pkgbuilder": "0.0.1",
    "versions": [
      "3.6",
      "4.0"
    ]
  }
}

You also need to start workers that will build packages

pkgbuilder::pb_worker("pb")

The version of R used by the worker must match one of the versions that the server supports (ignoring the patch version).

Submit a job that builds a package based on a github reference by posting to /<version>/submit/ref

$ curl -s --data '{"ref": "mrc-ide/dust"}' -H "Content-Type: application/json" \
  http://localhost:8080/4.0/submit/ref | jq
{
  "status": "success",
  "errors": null,
  "data": "4289a9a84808765ad1facf5af752ac77"
}

Retrieve job status using /<version>/status/<id>

$ curl -s http://localhost:8080/4.0/status/4289a9a84808765ad1facf5af752ac77 | jq
{
  "status": "success",
  "errors": null,
  "data": {
    "status": "WORKING",
    "log": null
  }
}

Retrieve the file using /<version>/result/<id>

$ curl -OJ http://localhost:8080/4.0/result/4289a9a84808765ad1facf5af752ac77
curl: Saved to filename 'dust_0.4.9.tgz'

License

MIT © Imperial College of Science, Technology and Medicine

mrc-ide/pkgbuilder documentation built on Sept. 1, 2020, 9:57 a.m.