Closed sbellem closed 4 years ago
Merging #412 into dev will decrease coverage by
0.01788%
. The diff coverage isn/a
.
@@ Coverage Diff @@
## dev #412 +/- ##
===================================================
- Coverage 77.23533% 77.21745% -0.01789%
===================================================
Files 50 50
Lines 5592 5592
Branches 856 856
===================================================
- Hits 4319 4318 -1
- Misses 1098 1099 +1
Partials 175 175
The main goal of this PR is to add logic to Travis CI to deploy documentation to Github Pages: https://initc3.github.io/HoneyBadgerMPC.
In order to speed up the builds that are done for branches that are on the initc3/HoneyBadgerMPC repo Docker Hub is used a cache: a build stage is added to build a docker image and push it to Docker Hub for subsequent re-use in other stages/jobs.
For now, the deployment of documentation will only be done for the
dev
branch, on initc3/HoneyBadgerMPC, referred as theDOCS_DEPLOY_BRANCH
. When code is merged into thedev
branch, if all tests and quality checks succeed, and if the documentation was generated with success then the docs are published to github pages. If the docs have not changed the deployment will not take place.Depending on whether a pull request or push event is from a fork or not the Travis CI build will differ. The main cases/events are:
dev
) on initc3/HoneybadgerMPC (example)dev
branch (DOCS_DEPLOY_BRANCH
) on initc3/HoneybadgerMPC (example -- note that theDOCS_DEPLOY_BRANCH
is notdev
for the example)TODO:
dev
env()
function call can be used with env varDOCS_DEPLOY_BRANCH
-- could not get it working. Asked on TravisCI forum: https://travis-ci.community/t/having-troubles-with-env/6508