kopia lustrzana https://github.com/jupyterhub/repo2docker
update repo URLs for jupyterhub/repo2docker
rodzic
47c456c20a
commit
60555b1d05
|
@ -79,7 +79,7 @@ deploy:
|
||||||
distributions: sdist bdist_wheel
|
distributions: sdist bdist_wheel
|
||||||
on:
|
on:
|
||||||
tags: true
|
tags: true
|
||||||
repo: jupyter/repo2docker
|
repo: jupyterhub/repo2docker
|
||||||
condition: "$REPO_TYPE = conda"
|
condition: "$REPO_TYPE = conda"
|
||||||
password:
|
password:
|
||||||
secure: Vcbr4UtckHRjKKhOFKyHkmBQRB9H3SnJvOoxuqXhzCR6JtVe2L1m4UJaSk5aq6CDauZI6fejYhMxJ6W5oqz2q7DH8RnemIVCmTaqTNqblQy6s1XK7iUjtWUtr+MfjFWNx99hqAy9VGVoi++9w4ZaDba448D69rkzVqQTJUjHTlJql66ZIyuPWLhgkWRxMNd5Hnwjf+ETc7efasD2NsvsASsI0AEZijjb+Lbi9V+hR1e1JTn+a8Gz4zskPGVT2kMTobLGE6ucfsYyPy/FxAp5GedEZdAaipjdHmN64ylV8fxDrsCKj4zwD+w43XJzJPJVpqmeYm93SKhWr2v5xn/IGFH/Ea/9/rzFogpDdCUIgv4/xNKgVFVaMalTSUs9aOwYoBVFrmWNkyPSv7vihgWtO2ljo239Eb81SHMiwnbsHG5Ao0XY32USn7CmLO7/BbnY+JVJpNHWoG/jdTn73OzXextGK30f7fp1IxSxhnGdMBkNbKeujOfmhtDj1DIyMM2eNy0YMprv90+d9zxn15PG3TjspXzM6d9wd7BhmuPfMnD6pC51l83S7kmTMJ9nK+WexACpZ0+jwLYsJUnwXClD4S1nZxaEW6cMfSEYFU/l93eyBQqiQC0EjvWCBXwfl8ZMVQr3gr/ZbqCVSaqtINri4JqA3iqHJl3mEdA2WJ5VDZw=
|
secure: Vcbr4UtckHRjKKhOFKyHkmBQRB9H3SnJvOoxuqXhzCR6JtVe2L1m4UJaSk5aq6CDauZI6fejYhMxJ6W5oqz2q7DH8RnemIVCmTaqTNqblQy6s1XK7iUjtWUtr+MfjFWNx99hqAy9VGVoi++9w4ZaDba448D69rkzVqQTJUjHTlJql66ZIyuPWLhgkWRxMNd5Hnwjf+ETc7efasD2NsvsASsI0AEZijjb+Lbi9V+hR1e1JTn+a8Gz4zskPGVT2kMTobLGE6ucfsYyPy/FxAp5GedEZdAaipjdHmN64ylV8fxDrsCKj4zwD+w43XJzJPJVpqmeYm93SKhWr2v5xn/IGFH/Ea/9/rzFogpDdCUIgv4/xNKgVFVaMalTSUs9aOwYoBVFrmWNkyPSv7vihgWtO2ljo239Eb81SHMiwnbsHG5Ao0XY32USn7CmLO7/BbnY+JVJpNHWoG/jdTn73OzXextGK30f7fp1IxSxhnGdMBkNbKeujOfmhtDj1DIyMM2eNy0YMprv90+d9zxn15PG3TjspXzM6d9wd7BhmuPfMnD6pC51l83S7kmTMJ9nK+WexACpZ0+jwLYsJUnwXClD4S1nZxaEW6cMfSEYFU/l93eyBQqiQC0EjvWCBXwfl8ZMVQr3gr/ZbqCVSaqtINri4JqA3iqHJl3mEdA2WJ5VDZw=
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
# <a href="https://github.com/jupyter/repo2docker"><img src="https://raw.githubusercontent.com/jupyter/repo2docker/3fa7444fca6ae2b51e590cbc9d83baf92738ca2a/docs/source/_static/images/repo2docker.png" height="48px" /> repo2docker</a>
|
# <a href="https://github.com/jupyterhub/repo2docker"><img src="https://raw.githubusercontent.com/jupyterhub/repo2docker/3fa7444fca6ae2b51e590cbc9d83baf92738ca2a/docs/source/_static/images/repo2docker.png" height="48px" /> repo2docker</a>
|
||||||
|
|
||||||
[](https://travis-ci.org/jupyter/repo2docker)
|
[](https://travis-ci.org/jupyterhub/repo2docker)
|
||||||
[](http://repo2docker.readthedocs.io/en/latest/?badge=latest)
|
[](http://repo2docker.readthedocs.io/en/latest/?badge=latest)
|
||||||
[](https://dev.azure.com/jupyter/repo2docker/_build/latest?definitionId=1&branchName=master)
|
[](https://dev.azure.com/jupyterhub/repo2docker/_build/latest?definitionId=1&branchName=master)
|
||||||
[](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html)
|
[](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html)
|
||||||
|
|
||||||
`repo2docker` fetches a git repository and builds a container image based on
|
`repo2docker` fetches a git repository and builds a container image based on
|
||||||
|
@ -41,7 +41,7 @@ pip install jupyter-repo2docker
|
||||||
To install from source:
|
To install from source:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/jupyter/repo2docker.git
|
git clone https://github.com/jupyterhub/repo2docker.git
|
||||||
cd repo2docker
|
cd repo2docker
|
||||||
pip install -e .
|
pip install -e .
|
||||||
```
|
```
|
||||||
|
|
|
@ -5,7 +5,7 @@ Help us stay on top of things (and get faster replies) by submitting them to
|
||||||
the right place:
|
the right place:
|
||||||
|
|
||||||
* for support questions please use https://discourse.jupyter.org/c/binder
|
* for support questions please use https://discourse.jupyter.org/c/binder
|
||||||
* repo2docker development related issues https://github.com/jupyter/repo2docker/issues/new
|
* repo2docker development related issues https://github.com/jupyterhub/repo2docker/issues/new
|
||||||
* if the https://mybinder.org site is down or has inaccessible pages: https://github.com/jupyterhub/mybinder.org-deploy/issues/new
|
* if the https://mybinder.org site is down or has inaccessible pages: https://github.com/jupyterhub/mybinder.org-deploy/issues/new
|
||||||
|
|
||||||
If you aren't sure where to go use https://discourse.jupyter.org/c/binder.
|
If you aren't sure where to go use https://discourse.jupyter.org/c/binder.
|
||||||
|
|
|
@ -126,7 +126,7 @@ commands:
|
||||||
should return any value other than `None` if the path matches what the ContentProvider is looking
|
should return any value other than `None` if the path matches what the ContentProvider is looking
|
||||||
for.
|
for.
|
||||||
|
|
||||||
> For example, the [`Local` ContentProvider](https://github.com/jupyter/repo2docker/blob/80b979f8580ddef184d2ba7d354e7a833cfa38a4/repo2docker/contentproviders/base.py#L64)
|
> For example, the [`Local` ContentProvider](https://github.com/jupyterhub/repo2docker/blob/80b979f8580ddef184d2ba7d354e7a833cfa38a4/repo2docker/contentproviders/base.py#L64)
|
||||||
> checks whether the argument is a valid local path. If so, then `detect(`
|
> checks whether the argument is a valid local path. If so, then `detect(`
|
||||||
> returns a dictionary: `{'path': source}` which defines the path to the repository.
|
> returns a dictionary: `{'path': source}` which defines the path to the repository.
|
||||||
> This path is used by `fetch()` to check that it matches the output directory.
|
> This path is used by `fetch()` to check that it matches the output directory.
|
||||||
|
@ -135,7 +135,7 @@ commands:
|
||||||
result in the contents of the repository being placed locally to a folder.
|
result in the contents of the repository being placed locally to a folder.
|
||||||
|
|
||||||
For more information on ContentProviders, take a look at
|
For more information on ContentProviders, take a look at
|
||||||
[the ContentProvider base class](https://github.com/jupyter/repo2docker/blob/80b979f8580ddef184d2ba7d354e7a833cfa38a4/repo2docker/contentproviders/base.py#L16-L60)
|
[the ContentProvider base class](https://github.com/jupyterhub/repo2docker/blob/80b979f8580ddef184d2ba7d354e7a833cfa38a4/repo2docker/contentproviders/base.py#L16-L60)
|
||||||
which has more explanation.
|
which has more explanation.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -34,8 +34,8 @@
|
||||||
extensions = ["sphinx.ext.extlinks", "sphinxcontrib.autoprogram", "recommonmark"]
|
extensions = ["sphinx.ext.extlinks", "sphinxcontrib.autoprogram", "recommonmark"]
|
||||||
|
|
||||||
extlinks = {
|
extlinks = {
|
||||||
"issue": ("https://github.com/jupyter/repo2docker/issues/%s", "Issue #"),
|
"issue": ("https://github.com/jupyterhub/repo2docker/issues/%s", "Issue #"),
|
||||||
"pr": ("https://github.com/jupyter/repo2docker/pull/%s", "PR #"),
|
"pr": ("https://github.com/jupyterhub/repo2docker/pull/%s", "PR #"),
|
||||||
"user": ("https://github.com/%s", "@"),
|
"user": ("https://github.com/%s", "@"),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -29,7 +29,7 @@ can be found on this page (and to the right).
|
||||||
that lets you install any kind of package,
|
that lets you install any kind of package,
|
||||||
including Python, R, and C/C++ packages.
|
including Python, R, and C/C++ packages.
|
||||||
``repo2docker`` does not use your ``environment.yml`` to create and activate a new conda environment.
|
``repo2docker`` does not use your ``environment.yml`` to create and activate a new conda environment.
|
||||||
Rather, it updates a base conda environment `defined here <https://github.com/jupyter/repo2docker/blob/master/repo2docker/buildpacks/conda/environment.yml>`_ with the packages listed in your ``environment.yml``.
|
Rather, it updates a base conda environment `defined here <https://github.com/jupyterhub/repo2docker/blob/master/repo2docker/buildpacks/conda/environment.yml>`_ with the packages listed in your ``environment.yml``.
|
||||||
This means that the environment will always have the same default name, not the name
|
This means that the environment will always have the same default name, not the name
|
||||||
specified in your ``environment.yml``.
|
specified in your ``environment.yml``.
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
# Add a new buildpack
|
# Add a new buildpack
|
||||||
|
|
||||||
A new buildpack is needed when a new language or a new package manager should be
|
A new buildpack is needed when a new language or a new package manager should be
|
||||||
supported. [Existing buildpacks](https://github.com/jupyter/repo2docker/tree/master/repo2docker/buildpacks)
|
supported. [Existing buildpacks](https://github.com/jupyterhub/repo2docker/tree/master/repo2docker/buildpacks)
|
||||||
are a good model for how new buildpacks should be structured.
|
are a good model for how new buildpacks should be structured.
|
||||||
See [the Buildpacks page](buildpacks) for more information about the
|
See [the Buildpacks page](buildpacks) for more information about the
|
||||||
structure of a buildpack.
|
structure of a buildpack.
|
||||||
|
|
|
@ -5,14 +5,14 @@ Add a new content provider
|
||||||
Adding a new content provider allows repo2docker to grab repositories from new
|
Adding a new content provider allows repo2docker to grab repositories from new
|
||||||
locations on the internet. To do so, you should take the following steps:
|
locations on the internet. To do so, you should take the following steps:
|
||||||
|
|
||||||
#. Sub-class the `ContentProvider class <https://github.com/jupyter/repo2docker/blob/master/repo2docker/contentproviders/base.py#L17>`_.
|
#. Sub-class the `ContentProvider class <https://github.com/jupyterhub/repo2docker/blob/master/repo2docker/contentproviders/base.py#L17>`_.
|
||||||
This will give you a skeleton class you can modify to support your new
|
This will give you a skeleton class you can modify to support your new
|
||||||
content provider.
|
content provider.
|
||||||
#. Implement a **detect()** method for the class. This takes an input
|
#. Implement a **detect()** method for the class. This takes an input
|
||||||
string (e.g., a URL or path) and determines if it points to this particular
|
string (e.g., a URL or path) and determines if it points to this particular
|
||||||
content provider. It should return a dictionary (called
|
content provider. It should return a dictionary (called
|
||||||
``spec`` that will be passed to the ``fetch()`` method. `For example, see the ZenodoProvider detect method <https://github.com/jupyter/repo2docker/pull/693/files#diff-a96fcf624176b06e21c3ef7f6f6a425bR31>`_.
|
``spec`` that will be passed to the ``fetch()`` method. `For example, see the ZenodoProvider detect method <https://github.com/jupyterhub/repo2docker/pull/693/files#diff-a96fcf624176b06e21c3ef7f6f6a425bR31>`_.
|
||||||
#. Implement a **fetch()** method for the class. This takes the dictionary ``spec`` as input, and
|
#. Implement a **fetch()** method for the class. This takes the dictionary ``spec`` as input, and
|
||||||
ensures the repository exists on disk (e.g., by downloading it) and
|
ensures the repository exists on disk (e.g., by downloading it) and
|
||||||
returns a path to it.
|
returns a path to it.
|
||||||
`For example, see the ZenodoProvider fetch method <https://github.com/jupyter/repo2docker/pull/693/files#diff-a96fcf624176b06e21c3ef7f6f6a425bR57>`_.
|
`For example, see the ZenodoProvider fetch method <https://github.com/jupyterhub/repo2docker/pull/693/files#diff-a96fcf624176b06e21c3ef7f6f6a425bR57>`_.
|
||||||
|
|
|
@ -13,19 +13,19 @@ There are many ways to contribute to repo2docker:
|
||||||
If you're reading a page or docstring and it doesn't make sense (or doesn't exist!), please let us know by opening a bug report.
|
If you're reading a page or docstring and it doesn't make sense (or doesn't exist!), please let us know by opening a bug report.
|
||||||
It's even more amazing if you can give us a suggested change.
|
It's even more amazing if you can give us a suggested change.
|
||||||
* **Fix bugs or add requested features.**
|
* **Fix bugs or add requested features.**
|
||||||
Have a look through the [issue tracker](https://github.com/jupyter/repo2docker/issues) and see if there are any tagged as ["help wanted"](https://github.com/jupyter/repo2docker/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
|
Have a look through the [issue tracker](https://github.com/jupyterhub/repo2docker/issues) and see if there are any tagged as ["help wanted"](https://github.com/jupyterhub/repo2docker/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22).
|
||||||
As the label suggests, we'd love your help!
|
As the label suggests, we'd love your help!
|
||||||
* **Report a bug.**
|
* **Report a bug.**
|
||||||
If repo2docker isn't doing what you thought it would do then open a [bug report](https://github.com/jupyter/repo2docker/issues/new?template=bug_report.md).
|
If repo2docker isn't doing what you thought it would do then open a [bug report](https://github.com/jupyterhub/repo2docker/issues/new?template=bug_report.md).
|
||||||
That issue template will ask you a few questions described in more detail below.
|
That issue template will ask you a few questions described in more detail below.
|
||||||
* **Suggest a new feature.**
|
* **Suggest a new feature.**
|
||||||
We know that there are lots of ways to extend repo2docker!
|
We know that there are lots of ways to extend repo2docker!
|
||||||
If you're interested in adding a feature then please open a [feature request](https://github.com/jupyter/repo2docker/issues/new?template=feature_request.md).
|
If you're interested in adding a feature then please open a [feature request](https://github.com/jupyterhub/repo2docker/issues/new?template=feature_request.md).
|
||||||
That issue template will ask you a few questions described in detail below.
|
That issue template will ask you a few questions described in detail below.
|
||||||
* **Review someone's Pull Request.**
|
* **Review someone's Pull Request.**
|
||||||
Whenever somebody proposes changes to the repo2docker codebase, the community reviews
|
Whenever somebody proposes changes to the repo2docker codebase, the community reviews
|
||||||
the changes, and provides feedback, edits, and suggestions. Check out the
|
the changes, and provides feedback, edits, and suggestions. Check out the
|
||||||
[open pull requests](https://github.com/jupyter/repo2docker/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc)
|
[open pull requests](https://github.com/jupyterhub/repo2docker/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc)
|
||||||
and provide feedback that helps improve the PR and get it merged. Please keep your
|
and provide feedback that helps improve the PR and get it merged. Please keep your
|
||||||
feedback positive and constructive!
|
feedback positive and constructive!
|
||||||
* **Tell people about repo2docker.**
|
* **Tell people about repo2docker.**
|
||||||
|
@ -40,15 +40,15 @@ If you're not sure where to get started, then please come and say hello in our [
|
||||||
|
|
||||||
This outlines the process for getting changes to the repo2docker project merged.
|
This outlines the process for getting changes to the repo2docker project merged.
|
||||||
|
|
||||||
1. Identify the correct issue template: [bug report](https://github.com/jupyter/repo2docker/issues/new?template=bug_report.md) or [feature request](https://github.com/jupyter/repo2docker/issues/new?template=feature_request.md).
|
1. Identify the correct issue template: [bug report](https://github.com/jupyterhub/repo2docker/issues/new?template=bug_report.md) or [feature request](https://github.com/jupyterhub/repo2docker/issues/new?template=feature_request.md).
|
||||||
|
|
||||||
**Bug reports** ([examples](https://github.com/jupyter/repo2docker/issues?q=is%3Aissue+is%3Aopen+label%3Abug), [new issue](https://github.com/jupyter/repo2docker/issues/new?template=bug_report.md)) will ask you for a description of the problem, the expected behaviour, the actual behaviour, how to reproduce the problem, and your personal set up.
|
**Bug reports** ([examples](https://github.com/jupyterhub/repo2docker/issues?q=is%3Aissue+is%3Aopen+label%3Abug), [new issue](https://github.com/jupyterhub/repo2docker/issues/new?template=bug_report.md)) will ask you for a description of the problem, the expected behaviour, the actual behaviour, how to reproduce the problem, and your personal set up.
|
||||||
Bugs can include problems with the documentation, or code not running as expected.
|
Bugs can include problems with the documentation, or code not running as expected.
|
||||||
|
|
||||||
It is really important that you make it easy for the maintainers to reproduce the problem you're having.
|
It is really important that you make it easy for the maintainers to reproduce the problem you're having.
|
||||||
This guide on creating a [minimal, complete and verifiable example](https://stackoverflow.com/help/mcve) is a great place to start.
|
This guide on creating a [minimal, complete and verifiable example](https://stackoverflow.com/help/mcve) is a great place to start.
|
||||||
|
|
||||||
**Feature requests** ([examples](https://github.com/jupyter/repo2docker/labels/needs%3A%20discussion), [new issue](https://github.com/jupyter/repo2docker/issues/new?template=feature_request.md)) will ask you for the proposed change, any alternatives that you have considered, a description of who would use this feature, and a best-guess of how much work it will take and what skills are required to accomplish.
|
**Feature requests** ([examples](https://github.com/jupyterhub/repo2docker/labels/needs%3A%20discussion), [new issue](https://github.com/jupyterhub/repo2docker/issues/new?template=feature_request.md)) will ask you for the proposed change, any alternatives that you have considered, a description of who would use this feature, and a best-guess of how much work it will take and what skills are required to accomplish.
|
||||||
|
|
||||||
Very easy feature requests might be updates to the documentation to clarify steps for new users.
|
Very easy feature requests might be updates to the documentation to clarify steps for new users.
|
||||||
Harder feature requests may be to add new functionality to the project and will need more in depth discussion about who can complete and maintain the work.
|
Harder feature requests may be to add new functionality to the project and will need more in depth discussion about who can complete and maintain the work.
|
||||||
|
@ -58,7 +58,7 @@ This outlines the process for getting changes to the repo2docker project merged.
|
||||||
|
|
||||||
2. Open an issue.
|
2. Open an issue.
|
||||||
Getting consensus with the community is a great way to save time later.
|
Getting consensus with the community is a great way to save time later.
|
||||||
3. Make edits in [your fork](https://help.github.com/en/articles/fork-a-repo) of the [repo2docker repository](https://github.com/jupyter/repo2docker).
|
3. Make edits in [your fork](https://help.github.com/en/articles/fork-a-repo) of the [repo2docker repository](https://github.com/jupyterhub/repo2docker).
|
||||||
4. Make a [pull request](https://help.github.com/en/articles/about-pull-requests).
|
4. Make a [pull request](https://help.github.com/en/articles/about-pull-requests).
|
||||||
Read the [next section](#guidelines-to-getting-a-pull-request-merged) for guidelines for both reviewers and contributors on merging a PR.
|
Read the [next section](#guidelines-to-getting-a-pull-request-merged) for guidelines for both reviewers and contributors on merging a PR.
|
||||||
5. Edit [the changelog](./../../changelog) by appending your feature / bug fix to the development version.
|
5. Edit [the changelog](./../../changelog) by appending your feature / bug fix to the development version.
|
||||||
|
|
|
@ -43,7 +43,7 @@ This means this list should not be exhaustive, it should only represent
|
||||||
the "top of the stack" of ideas. It should
|
the "top of the stack" of ideas. It should
|
||||||
not function as a wish list, collection of feature requests or todo list.
|
not function as a wish list, collection of feature requests or todo list.
|
||||||
For those please create a
|
For those please create a
|
||||||
[new issue](https://github.com/jupyter/repo2docker/issues/new).
|
[new issue](https://github.com/jupyterhub/repo2docker/issues/new).
|
||||||
|
|
||||||
The roadmap should give the reader an idea of what is happening next, what needs
|
The roadmap should give the reader an idea of what is happening next, what needs
|
||||||
input and discussion before it can happen and what has been postponed.
|
input and discussion before it can happen and what has been postponed.
|
||||||
|
@ -60,9 +60,9 @@ creating the environment in which a piece of software can be executed.
|
||||||
|
|
||||||
The "Now" items are being actively worked on by the project:
|
The "Now" items are being actively worked on by the project:
|
||||||
* reduce documentation typos and syntax errors
|
* reduce documentation typos and syntax errors
|
||||||
* increase test coverage to 80% (see https://codecov.io/gh/jupyter/repo2docker/tree/master/repo2docker for low coverage files)
|
* increase test coverage to 80% (see https://codecov.io/gh/jupyterhub/repo2docker/tree/master/repo2docker for low coverage files)
|
||||||
* mounting repository contents in locations that is not `/home/jovyan`
|
* mounting repository contents in locations that is not `/home/jovyan`
|
||||||
* investigate options for pinning repo2docker versions ([#490](https://github.com/jupyter/repo2docker/issues/490))
|
* investigate options for pinning repo2docker versions ([#490](https://github.com/jupyterhub/repo2docker/issues/490))
|
||||||
|
|
||||||
|
|
||||||
### Soon
|
### Soon
|
||||||
|
@ -72,8 +72,8 @@ item reaches the point of an actionable plan and person who wants to work on
|
||||||
it, the item will be moved to the "Now" section. Typically, these will be moved
|
it, the item will be moved to the "Now" section. Typically, these will be moved
|
||||||
at a future review of the roadmap.
|
at a future review of the roadmap.
|
||||||
* create the contributor highway, define the route from newcomer to project lead
|
* create the contributor highway, define the route from newcomer to project lead
|
||||||
* add Julia Manifest support (https://docs.julialang.org/en/v1/stdlib/Pkg/index.html, [#486](https://github.com/jupyter/repo2docker/issues/486))
|
* add Julia Manifest support (https://docs.julialang.org/en/v1/stdlib/Pkg/index.html, [#486](https://github.com/jupyterhub/repo2docker/issues/486))
|
||||||
* support different base images/build pack stacks ([#487](https://github.com/jupyter/repo2docker/issues/487))
|
* support different base images/build pack stacks ([#487](https://github.com/jupyterhub/repo2docker/issues/487))
|
||||||
|
|
||||||
|
|
||||||
### Later
|
### Later
|
||||||
|
|
|
@ -48,8 +48,8 @@ To update one of the dependencies shared across all `repo2docker` builds, you
|
||||||
must follow these steps (with more detailed information in the sections below):
|
must follow these steps (with more detailed information in the sections below):
|
||||||
|
|
||||||
1. Make sure you have [Docker](https://www.docker.com/) running on your computer
|
1. Make sure you have [Docker](https://www.docker.com/) running on your computer
|
||||||
2. Bump the version numbers of the dependencies you want to update in the `conda` environment ([link](https://github.com/jupyter/repo2docker/blob/master/CONTRIBUTING.md#conda-dependencies))
|
2. Bump the version numbers of the dependencies you want to update in the `conda` environment ([link](https://github.com/jupyterhub/repo2docker/blob/master/CONTRIBUTING.md#conda-dependencies))
|
||||||
3. Make a pull request with your changes ([link](https://github.com/jupyter/repo2docker/blob/master/CONTRIBUTING.md#make-a-pull-request))
|
3. Make a pull request with your changes ([link](https://github.com/jupyterhub/repo2docker/blob/master/CONTRIBUTING.md#make-a-pull-request))
|
||||||
|
|
||||||
See the subsections below for more detailed instructions.
|
See the subsections below for more detailed instructions.
|
||||||
|
|
||||||
|
@ -118,13 +118,13 @@ We follow [semantic versioning](https://semver.org/).
|
||||||
|
|
||||||
A new release will automatically be created when a new git tag is created
|
A new release will automatically be created when a new git tag is created
|
||||||
and pushed to the repository (using
|
and pushed to the repository (using
|
||||||
[Travis CI](https://github.com/jupyter/repo2docker/blob/master/.travis.yml#L52)).
|
[Travis CI](https://github.com/jupyterhub/repo2docker/blob/master/.travis.yml#L52)).
|
||||||
|
|
||||||
To create a new release, follow these steps:
|
To create a new release, follow these steps:
|
||||||
|
|
||||||
### Confirm that the changelog is ready
|
### Confirm that the changelog is ready
|
||||||
|
|
||||||
[The changelog](https://github.com/jupyter/repo2docker/blob/master/docs/source/changelog.rst)
|
[The changelog](https://github.com/jupyterhub/repo2docker/blob/master/docs/source/changelog.rst)
|
||||||
should reflect all significant enhancements and fixes to repo2docker and
|
should reflect all significant enhancements and fixes to repo2docker and
|
||||||
its documentation. In addition, ensure that the correct version is displayed
|
its documentation. In addition, ensure that the correct version is displayed
|
||||||
at the top, and create a new `dev` section if needed.
|
at the top, and create a new `dev` section if needed.
|
||||||
|
@ -150,12 +150,12 @@ Once this has completed, make sure that the new version has been updated.
|
||||||
### Create a new release on the GitHub repository
|
### Create a new release on the GitHub repository
|
||||||
|
|
||||||
Once the new release has been pushed to PyPI, we need to create a new
|
Once the new release has been pushed to PyPI, we need to create a new
|
||||||
release on the [GitHub repository releases page](https://github.com/jupyter/repo2docker/releases). Once on that page, follow these steps:
|
release on the [GitHub repository releases page](https://github.com/jupyterhub/repo2docker/releases). Once on that page, follow these steps:
|
||||||
|
|
||||||
* Click "Draft a new release"
|
* Click "Draft a new release"
|
||||||
* Choose a tag version using the same tag you just created above
|
* Choose a tag version using the same tag you just created above
|
||||||
* The release name is simply the tag version
|
* The release name is simply the tag version
|
||||||
* The description is [a link to the Changelog](https://github.com/jupyter/repo2docker/blob/master/docs/source/changelog.rst),
|
* The description is [a link to the Changelog](https://github.com/jupyterhub/repo2docker/blob/master/docs/source/changelog.rst),
|
||||||
ideally with an anchor to the latest release.
|
ideally with an anchor to the latest release.
|
||||||
* Finally, click "Publish release"
|
* Finally, click "Publish release"
|
||||||
|
|
||||||
|
@ -229,7 +229,7 @@ echo "Comparing $(pwd) (local $current_version vs. $R2D_COMPARE_TO)"
|
||||||
basename="dockerfilediff"
|
basename="dockerfilediff"
|
||||||
|
|
||||||
diff_r2d_dockerfiles_with_version () {
|
diff_r2d_dockerfiles_with_version () {
|
||||||
docker run --rm -t -v "$(pwd)":"$(pwd)" --user 1000 jupyter/repo2docker:"$1" jupyter-repo2docker --no-build --debug "$(pwd)" &> "$basename"."$1"
|
docker run --rm -t -v "$(pwd)":"$(pwd)" --user 1000 jupyterhub/repo2docker:"$1" jupyter-repo2docker --no-build --debug "$(pwd)" &> "$basename"."$1"
|
||||||
jupyter-repo2docker --no-build --debug "$(pwd)" &> "$basename"."$current_version"
|
jupyter-repo2docker --no-build --debug "$(pwd)" &> "$basename"."$current_version"
|
||||||
|
|
||||||
# remove first line logging the path
|
# remove first line logging the path
|
||||||
|
|
|
@ -28,7 +28,7 @@ Repo2docker officially supports the following versions of Python
|
||||||
- 2.7
|
- 2.7
|
||||||
|
|
||||||
Additional versions may work, as long as the
|
Additional versions may work, as long as the
|
||||||
`base environment <https://github.com/jupyter/repo2docker/blob/master/repo2docker/buildpacks/conda/environment.yml>`_
|
`base environment <https://github.com/jupyterhub/repo2docker/blob/master/repo2docker/buildpacks/conda/environment.yml>`_
|
||||||
can be installed for your version of Python.
|
can be installed for your version of Python.
|
||||||
The most likely source of incompatibility is if one of the packages
|
The most likely source of incompatibility is if one of the packages
|
||||||
in the base environment is not packaged for your Python,
|
in the base environment is not packaged for your Python,
|
||||||
|
|
|
@ -17,9 +17,9 @@ are pushed to a Docker registry.
|
||||||
``repo2docker`` is the tool used by `BinderHub <https://binderhub.readthedocs.io>`_
|
``repo2docker`` is the tool used by `BinderHub <https://binderhub.readthedocs.io>`_
|
||||||
to build images on demand.
|
to build images on demand.
|
||||||
|
|
||||||
Please report `Bugs <https://github.com/jupyter/repo2docker/issues>`_,
|
Please report `Bugs <https://github.com/jupyterhub/repo2docker/issues>`_,
|
||||||
`ask questions <https://gitter.im/jupyterhub/binder>`_ or
|
`ask questions <https://gitter.im/jupyterhub/binder>`_ or
|
||||||
`contribute to the project <https://github.com/jupyter/repo2docker/blob/master/CONTRIBUTING.md>`_.
|
`contribute to the project <https://github.com/jupyterhub/repo2docker/blob/master/CONTRIBUTING.md>`_.
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
|
@ -31,7 +31,7 @@ We recommend installing ``repo2docker`` with the ``pip`` tool::
|
||||||
|
|
||||||
for the latest release. To install the most recent code from the upstream repository, run::
|
for the latest release. To install the most recent code from the upstream repository, run::
|
||||||
|
|
||||||
python3 -m pip install https://github.com/jupyter/repo2docker/archive/master.zip
|
python3 -m pip install https://github.com/jupyterhub/repo2docker/archive/master.zip
|
||||||
|
|
||||||
For information on using ``repo2docker``, see :ref:`usage`.
|
For information on using ``repo2docker``, see :ref:`usage`.
|
||||||
|
|
||||||
|
@ -41,7 +41,7 @@ Installing from source code
|
||||||
Alternatively, you can install repo2docker from a local source tree,
|
Alternatively, you can install repo2docker from a local source tree,
|
||||||
e.g. in case you are contributing back to this project::
|
e.g. in case you are contributing back to this project::
|
||||||
|
|
||||||
git clone https://github.com/jupyter/repo2docker.git
|
git clone https://github.com/jupyterhub/repo2docker.git
|
||||||
cd repo2docker
|
cd repo2docker
|
||||||
python3 -m pip install -e .
|
python3 -m pip install -e .
|
||||||
|
|
||||||
|
|
|
@ -39,7 +39,7 @@ def validate_image_name(image_name):
|
||||||
return image_name
|
return image_name
|
||||||
|
|
||||||
|
|
||||||
# See https://github.com/jupyter/repo2docker/issues/871 for reason
|
# See https://github.com/jupyterhub/repo2docker/issues/871 for reason
|
||||||
class MimicDockerEnvHandling(argparse.Action):
|
class MimicDockerEnvHandling(argparse.Action):
|
||||||
def __call__(self, parser, namespace, values, option_string=None):
|
def __call__(self, parser, namespace, values, option_string=None):
|
||||||
# There are 3 cases:
|
# There are 3 cases:
|
||||||
|
|
4
setup.py
4
setup.py
|
@ -63,8 +63,8 @@ setup(
|
||||||
project_urls={
|
project_urls={
|
||||||
"Documentation": "https://repo2docker.readthedocs.io",
|
"Documentation": "https://repo2docker.readthedocs.io",
|
||||||
"Funding": "https://jupyter.org/about",
|
"Funding": "https://jupyter.org/about",
|
||||||
"Source": "https://github.com/jupyter/repo2docker/",
|
"Source": "https://github.com/jupyterhub/repo2docker/",
|
||||||
"Tracker": "https://github.com/jupyter/repo2docker/issues",
|
"Tracker": "https://github.com/jupyterhub/repo2docker/issues",
|
||||||
},
|
},
|
||||||
# this should be a whitespace separated string of keywords, not a list
|
# this should be a whitespace separated string of keywords, not a list
|
||||||
keywords="reproducible science environments docker",
|
keywords="reproducible science environments docker",
|
||||||
|
|
|
@ -8,7 +8,7 @@ kernel to actually give us real memory.
|
||||||
NOTE: This file has to be duplicated & present in all the following locations:
|
NOTE: This file has to be duplicated & present in all the following locations:
|
||||||
- tests/memlimit/dockerfile/postBuild
|
- tests/memlimit/dockerfile/postBuild
|
||||||
- tests/memlimit/dockerfile/postBuild
|
- tests/memlimit/dockerfile/postBuild
|
||||||
See https://github.com/jupyter/repo2docker/issues/160 for reason
|
See https://github.com/jupyterhub/repo2docker/issues/160 for reason
|
||||||
"""
|
"""
|
||||||
from ctypes import cdll, c_void_p, memset
|
from ctypes import cdll, c_void_p, memset
|
||||||
import os
|
import os
|
||||||
|
|
|
@ -8,7 +8,7 @@ kernel to actually give us real memory.
|
||||||
NOTE: This file has to be duplicated & present in all the following locations:
|
NOTE: This file has to be duplicated & present in all the following locations:
|
||||||
- tests/memlimit/dockerfile/postBuild
|
- tests/memlimit/dockerfile/postBuild
|
||||||
- tests/memlimit/dockerfile/postBuild
|
- tests/memlimit/dockerfile/postBuild
|
||||||
See https://github.com/jupyter/repo2docker/issues/160 for reason
|
See https://github.com/jupyterhub/repo2docker/issues/160 for reason
|
||||||
"""
|
"""
|
||||||
from ctypes import cdll, c_void_p, memset
|
from ctypes import cdll, c_void_p, memset
|
||||||
import os
|
import os
|
||||||
|
|
|
@ -55,7 +55,7 @@ def test_memlimit_same_postbuild():
|
||||||
Validate that the postBuild files for the dockerfile and non-dockerfile
|
Validate that the postBuild files for the dockerfile and non-dockerfile
|
||||||
tests are the same
|
tests are the same
|
||||||
|
|
||||||
Until https://github.com/jupyter/repo2docker/issues/160 gets fixed.
|
Until https://github.com/jupyterhub/repo2docker/issues/160 gets fixed.
|
||||||
"""
|
"""
|
||||||
filepaths = [
|
filepaths = [
|
||||||
os.path.join(basedir, "memlimit", t, "postBuild")
|
os.path.join(basedir, "memlimit", t, "postBuild")
|
||||||
|
|
|
@ -142,8 +142,8 @@ def test_open_guess_encoding():
|
||||||
),
|
),
|
||||||
("file://subdir", True),
|
("file://subdir", True),
|
||||||
("file://./subdir", True),
|
("file://./subdir", True),
|
||||||
("git://github.com/jupyter/repo2docker", False),
|
("git://github.com/jupyterhub/repo2docker", False),
|
||||||
("git+https://github.com/jupyter/repo2docker", False),
|
("git+https://github.com/jupyterhub/repo2docker", False),
|
||||||
("numpy", False),
|
("numpy", False),
|
||||||
("# -e .", False),
|
("# -e .", False),
|
||||||
],
|
],
|
||||||
|
|
Ładowanie…
Reference in New Issue