You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-10
Original file line number
Diff line number
Diff line change
@@ -1,32 +1,36 @@
1
1
# repo2docker-githubci
2
-
a template for building jupyterhub-compatible docker images with repo2docker and github actions
2
+
a template for building [JupyterHub](https://jupyter.org/hub) environments with [Repo2Docker](https://repo2docker.readthedocs.io/en/latest/) and [GitHub Actions CI](https://help.github.com/en/actions/automating-your-workflow-with-github-actions)
1) modify readme links and any files in the `binder/` folder
20
+
21
+
1) build with GitHub Actions by pushing to GitHub
18
22
* commits to master branch trigger re-building image tagged by github short sha and 'latest'
19
23
```
20
24
git commit -a -m "modified binder/environment to my liking"
21
25
git push
22
26
```
23
27
* pushing a tag results in a docker image with the same tag:
24
28
```
25
-
git tag -am "test v2.3.2" v2.3.2
29
+
git tag -am "tagging 2.3.2" 2.3.2
26
30
git push --tags
27
31
```
28
32
29
-
### grab your image to run locally
33
+
### Pull your image to run a local JupyterLab session
30
34
```
31
35
export IMAGE=scottyhq/repo2docker-github
32
36
export TAG=latest
@@ -36,7 +40,6 @@ docker stop repo2docker
36
40
docker rm repo2docker
37
41
```
38
42
39
-
### or run on a binderhub
40
-
Just point to the imagein a seperate repo containing notebooks you want to run:
43
+
### Run your image on a BinderHub
44
+
Now that you have images on DockerHub, you can re-use them in many ways. For example, create a BinderHub compatible content repository with 'binder' branch that points to a specific image. All your notebooks and scripts can be in the 'master' branch, and are pulled into a BinderHub session with [nbgitpuller](https://github.com/jupyterhub/nbgitpuller). Structuring things this way means that changes to your scripts won't trigger rebuilding large images:
0 commit comments