WIP: Github actions

[arokem]

This is what a GA workflow for unit testing might look like.

We can also implement some of the other jobs/pipelines currently implemented by CircleCI:

• Doc building
• Deploying to PyPI (need to deal with versioneer)

[pull-assistant]

Best reviewed: commit by commit

---

Optimal code review plan (3 warnings, 2 commits squashed)

     Adds an initial Github Actions config for test suite.

     This is actually a bit simpler.

     Adds a documentation build GA workflow.

     Try building this only once. Upload from correct path.

     Explicitly set to use Python 3.7

Adds a docker build/... ... Tweak tweak.

Squashed 2 commits:

• Adds a docker build/push workflow.

• Tweak tweak.

.github/workflows/docker.yml 50% changes removed in Use the bash script ...

     Rename this step to make sense.

Use the bash script from the circleci config instead.

.github/workflows/docker.yml 86% changes removed in Use the canned actio...

     We might need Python 3.7 here.

     Install pyenv.

     Set up pyenv.

     Maybe we need to do this setup in the next step.

     We don't need pyenv here.

Push to dockerhub based on a condition.

.github/workflows/docker.yml 57% changes removed in Use the canned actio...

     Be more specific about what this is.

     Remove the cache-from argument.

     Use the canned action again.

     Reinstate custom docker build.

     Move pytest options to setup.cfg.

     Fixes docbuild.

     Correct directory name ("doc" => "docs")

     Need to also provide the make directive ("html")

Powered by Pull Assistant. Last update ee7f81a ... d02f1d5. Read the comment docs.

[codecov]

Codecov Report

Merging #52 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #52   +/-   ##
=======================================
  Coverage   55.51%   55.51%           
=======================================
  Files          11       11           
  Lines         762      762           
  Branches      110      110           
=======================================
  Hits          423      423           
  Misses        338      338           
  Partials        1        1

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5bd7fcf...d02f1d5. Read the comment docs.

[arokem]

I think that this is ready to go. This now (hopefully) does: test-suite, documentation build and docker image building. I will do the pypi deploy stuff on a separate PR.

[arokem]

Please hold off on merging this for now. The recent 079a3b2 tries to use the canned action again. I might back off this in the end, but the developer of this action has made the additional effort of implementing this, so the least I can do is give it a whirl.

[oesteban]

please remove this line (and apply the next suggestion)

[oesteban]

Suggested change

	make html
	make -C docs html

The rationale is that the makefile under docs/ inserts PWD in the pythonpath and you want it to be the root of the project :)

[oesteban]

We'll need to think a bit further about this:

• If you just run make -C doc then the current version of the docs is built.
• If you are to deploy, then the appropriate commandline is make -f ./docs/Makefile versioned CURBRANCH=${CIRCLE_TAG:-$CIRCLE_BRANCH} (replace $CIRCLE_TAG and $CIRCLE_BRANCH with appropriate values).

then, the versioned docs are deployed to gh-pages:

dmriprep/.circleci/config.yml

Lines 505 to 525 in b98c7e9

	- run:
	name: Generate Versioned Docs
	command: |
	set +e
	force_versioned="$( git log --format=oneline -n 1 $CIRCLE_SHA1 | grep -i -E '\[docs?[ _]?versions?\]' )"
	set -e
	if [[ "x${CIRCLE_TAG}" = "x" && "${CIRCLE_BRANCH}" != "master" && "x${force_versioned}" = "x" ]]; then
	echo "Not a tag or master branch - skipping versioned docs."
	circleci step halt
	else
	make -f ./docs/Makefile versioned CURBRANCH=${CIRCLE_TAG:-$CIRCLE_BRANCH}
	fi
	- save_cache:
	key: docs-v1-{{ .Branch }}-{{ .Revision }}
	paths:
	- ./docs/_build/_html
	- persist_to_workspace:
	root: docs/_build
	paths: html
	- store_artifacts:
	path: ./docs/_build/html

(the path that gets pushed is not the non-versioned docs)

[arokem]

Done (maybe?) in 313f5bf

[oesteban]

the options to pytest would be better set within the setup.cfg file.

[arokem]

Done in 0cc7787

[oesteban]

I have added some github actions workflow to test package builds. Can we split this one and maybe add those workflows we want to keep?

[oesteban]

Closing for now.