Add default circle configuration

binder-examples / continuous-build

Show how to use continuous integration to test your dependency specifications

BSD 3-Clause "New" or "Revised" License

8 stars 10 forks source link

Add default circle configuration #1

Closed vsoch closed 6 years ago

vsoch commented 6 years ago

This pull request will add the basic (one might say a reasonable default) to show an example continuous build using jupyter-repo2docker. The documentation (README) here is intentionally sparse, and points the user to the jupyter repo2docker base that is the central source of information (we wouldn't want to need to change things twice!).

The same as before build on Circle is here.
The Docker Hub deployment is still here.
The PR with docs for usage is underway here

Woot!

vsoch commented 6 years ago

@minrk and @betatim I realize I don't know who the maintainers are of this organization, so I'll ping you to get linked with the right people. The PR linked above also had a conflict (I had also updated the repository to the working one) so now it's fixed and again testing.

minrk commented 6 years ago

I enabled CircleCI, so I think this PR will be tested if you push a new commit.

vsoch commented 6 years ago

cool! There it goes!

minrk commented 6 years ago

Very cool, thanks!

vsoch commented 6 years ago

Awesome!

It looks like the tests happened with my CI setup (and likely circle does this to be smart and not have redundant builds?) so when the time comes for a PR to this repo (that doesn't have CI) we will want to make sure the pull request triggers it (note it's not default, it needs to be enabled for PRs). The other detail is that, when other build configs are added, we will need to figure out how to be clever and test the config for a build... within a build! When the time comes we can likely reach out to circle to ask about this, or do something even simpler like having one template per branch.

minrk commented 6 years ago

I think that's an issue with circle's reporting when the PR author has enabled it on their fork. I did check the "test pull requests" box.

The build on master did fail so maybe there's something missing in the master builds env variables that were on your branch? If you have the chance to update it with another PR, that would be great!

vsoch commented 6 years ago

The REPO_NAME where the notebook is to be pulled and then built has to be defined in the circle environment variables for this repo. It's defined for my fork so it passes, but I'm not able to edit the circle settings for this one!

vsoch commented 6 years ago

Perhaps we should update so that if the variable isn't defined, it spits out a warning message? Should tests fail if it isn't defined?

minrk commented 6 years ago

Can you define it as an environment variable for the job in the .circleci/config.yaml? That way all the info is available in the repo, not just to repo owners.

vsoch commented 6 years ago

Yes! It would work to be defined in both places.