Skip to content

Add a Docker Image for testing and doc building in an isolated environment #1075

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.

Sign up for GitHub

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

Jump to bottom
Merged
mfeurer merged 17 commits into from
May 7, 2021
Merged

Add a Docker Image for testing and doc building in an isolated environment #1075

mfeurer merged 17 commits into from
May 7, 2021

Conversation

@PGijsbers
Copy link
Collaborator

@PGijsbers PGijsbers commented May 6, 2021 •
edited
Loading

Due to my recent difficulties building the docs from my Windows machine (still not sure why it broke), I decided to make a docker image that can be used to:

  • run the latest openml-python development version. Note: 'latest' at the time of building, this PR does not yet include the automation to rebuild and push the docker image on each push to develop.
  • run unit tests on your local repository (mounted), or any online branch (on this repository or a fork)
  • build documentation on your local repository (mounted), or any online branch (on this repository or a fork)

Please refer to the included documentation for more information.
I think it'll be useful for anyone who wishes to execute these tasks in an isolated environment, though the primary audience is probably Windows users.

Looking for feedback, but I will still add:

  • A link to the readme from the documentation.
  • A note in the progress log.

@PGijsbers PGijsbers requested a review from mfeurer May 6, 2021 16:25
mfeurer
mfeurer reviewed May 6, 2021
View reviewed changes
Copy link
Collaborator

@mfeurer mfeurer left a comment

Choose a reason for hiding this comment

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

I just skimmed this and left a few comments. I think this is a good idea. Do you plan to add a build action to github actions?

@PGijsbers
Copy link
Collaborator Author

PGijsbers commented May 7, 2021

I added a Github workflow that automatically builds and pushes a docker image on a push to develop or docker (the latter is only for development purposes, but I figured it might come in handy later too so I did not remove it).
The only unresolved issue is that the image is always pushed with the openml/openml-python:latest tag only. I tried to also push with the GITHUB_SHA tag, but that wouldn't take for some reason. I can dive into the syntax for that another time, but I don't have time for it now.
Documentation is also updated. New links point to main instead of master.

@PGijsbers PGijsbers requested a review from mfeurer May 7, 2021 10:02
mfeurer
mfeurer reviewed May 7, 2021
View reviewed changes
Copy link
Collaborator

@mfeurer mfeurer left a comment

Choose a reason for hiding this comment

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

This looks good, interestingly, the workflow is a bit different to the one we use in Auto-sklearn (https://github.com/automl/auto-sklearn/blob/master/.github/workflows/docker-publish.yml). I think we can copy over one or two things, such as running the unit tests and correctly setting the tag, but besides that it looks good to me.

@mfeurer mfeurer merged commit 97d67e7 into develop May 7, 2021
@mfeurer mfeurer deleted the docker branch May 7, 2021 15:08
PGijsbers added a commit to Mirkazemi/openml-python that referenced this pull request Feb 23, 2023
@PGijsbers @mfeurer
Add a Docker Image for testing and doc building in an isolated enviro…
621df6f 
…nment (openml#1075)

* Initial structure

* Add doc and test functionality for mounted repo

* Add branch support and safeguards

* Update docker usage and name, add structure

* Improved formatting

* Add reference to docker image from main docs

* Add Workflow to build and push docker image

* Use environment variable directly

* Try other formatting for SHA tag

* Try format as string

* Only push latest

* Explicitly make context relative

* Checkout repository

* Install wheel and setuptools before other packages

* Rename master to main

* Add information about Docker PR

* Make 'note' italtics instead of content

Co-authored-by: Matthias Feurer <[email protected]>

Co-authored-by: Matthias Feurer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mfeurer mfeurer mfeurer approved these changes

Assignees

No one assigned

Labels

enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@PGijsbers @mfeurer