Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run Neo4j notebooks on GitHub Actions #1694

Merged
merged 15 commits into from Jun 23, 2020

Conversation

huonw
Copy link
Member

@huonw huonw commented Jun 19, 2020

This expands on #1692 to also run the notebooks that use Neo4j on our new GitHub Actions CI.

It does this by using docker-compose to manually run the Neo4j image in the background. This is a bit clunky, but is done in the interests of getting something working now. In particular, I couldn't work out how to use the native support for "services" for a job (https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idservices) to build the image from a local dockerfile.

See: #1687

Base automatically changed from feature/1687-github-actions-notebooks to develop June 22, 2020 00:39
huonw added a commit that referenced this pull request Jun 22, 2020
This runs all the basic Jupyter notebooks on Github Actions, in parallel. It
does this in the simplest way to get parallelism (and also, the simplest way to
get a "loop" in GitHub Actions configuration), with a large job matrix:
https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix

The matrix has to be manually specified, so a new script
`scripts/ci/ci_workflow_notebook_list.py` is added, that checks that the matrix
of notebooks matches the notebooks on disk.

This script is better if it is simple, and it's better if the configuration all
in one place in the `ci.yml` file. Thus, the notebooks that aren't run in the
default configuration (such as Neo4j notebooks #1694, and notebooks that fail
#818 #819) are still listed and then excluded with `exclude`:
https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#example-excluding-configurations-from-a-matrix

See: #1687
@codeclimate
Copy link

codeclimate bot commented Jun 22, 2020

Code Climate has analyzed commit af19d77 and detected 0 issues on this pull request.

View more on Code Climate.

@huonw huonw marked this pull request as ready for review June 22, 2020 02:12
@huonw huonw requested review from TheDen and timpitman June 22, 2020 02:12
Copy link
Contributor

@timpitman timpitman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The last big piece of the github actions puzzle, congrats!

@@ -0,0 +1,13 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could this file should have a more descriptive name than just "docker-compose.yml"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Potentially, but maybe the ci directory name is enough?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll rename to "actions-docker-compose.yml" since it's having to be used with the -f argument anyway and so docker-compose's default of looking for ./docker-compose.yml doesn't help.

@huonw huonw merged commit ba95b0e into develop Jun 23, 2020
@huonw huonw deleted the feature/1687-github-actions-neo4j-notebooks branch June 23, 2020 02:46
@huonw huonw mentioned this pull request Jun 23, 2020
24 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants