Skip to content

Commit ae3aeb6

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent 94bd21e commit ae3aeb6

File tree

11 files changed

+125
-123
lines changed

11 files changed

+125
-123
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
11
---
22
name: Bug report
33
about: Create a report to help us repair something that is currently broken
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
4+
title: ""
5+
labels: ""
6+
assignees: ""
87
---
8+
99
<!-- Thank you for contributing. These HTML commments will not render in the issue, but you can delete them once you've read them if you prefer! -->
1010

1111
### Bug description
12+
1213
<!-- Use this section to clearly and concisely describe the bug. -->
1314

1415
#### Expected behaviour
16+
1517
<!-- Tell us what you thought would happen. -->
1618

1719
#### Actual behaviour
20+
1821
<!-- Tell us what you actually happens. -->
1922

2023
### How to reproduce
24+
2125
<!-- Use this section to describe the steps that a user would take to experience this bug. -->
2226

2327
1. Go to '...'
@@ -26,9 +30,9 @@ assignees: ''
2630
4. See error
2731

2832
### Your personal set up
29-
<!-- Tell us a little about the system you're using. You can see the guidelines for setting up and reporting this information at https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html#setting-up-for-local-development. -->
3033

31-
- OS: [e.g. linux, OSX]
32-
- Docker version: `docker version` <!-- Run this command to get your version. -->
33-
- repo2docker version `repo2docker --version` <!-- Run this command to get your version. -->
34+
<!-- Tell us a little about the system you're using. You can see the guidelines for setting up and reporting this information at https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html#setting-up-for-local-development. -->
3435

36+
- OS: [e.g. linux, OSX]
37+
- Docker version: `docker version` <!-- Run this command to get your version. -->
38+
- repo2docker version `repo2docker --version` <!-- Run this command to get your version. -->
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
22
name: Feature request
33
about: Suggest a new feature or a big change to repo2docker
4-
title: ''
5-
labels: 'needs: discussion'
6-
assignees: ''
7-
4+
title: ""
5+
labels: "needs: discussion"
6+
assignees: ""
87
---
8+
99
<!-- Thank you for contributing. These HTML commments will not render in the issue, but you can delete them once you've read them if you prefer! -->
1010

1111
### Proposed change
12-
<!-- Use this section to describe the feature you'd like to be added. -->
1312

13+
<!-- Use this section to describe the feature you'd like to be added. -->
1414

1515
### Alternative options
16-
<!-- Use this section to describe alternative options and why you've decided on the proposed feature above. -->
1716

17+
<!-- Use this section to describe alternative options and why you've decided on the proposed feature above. -->
1818

1919
### Who would use this feature?
20-
<!-- Describe the audience for this feature. This information will affect who chooses to work on the feature with you. -->
2120

21+
<!-- Describe the audience for this feature. This information will affect who chooses to work on the feature with you. -->
2222

2323
### How much effort will adding it take?
24-
<!-- Try to estimate how much work adding this feature will require. This information will affect who chooses to work on the feature with you. -->
2524

25+
<!-- Try to estimate how much work adding this feature will require. This information will affect who chooses to work on the feature with you. -->
2626

2727
### Who can do this work?
28-
<!-- What skills are needed? Who can be recruited to add this feature? This information will affect who chooses to work on the feature with you. -->
2928

29+
<!-- What skills are needed? Who can be recruited to add this feature? This information will affect who chooses to work on the feature with you. -->

.github/ISSUE_TEMPLATE/support-question.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: Support question
33
about: Ask a question about using repo2docker
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
4+
title: ""
5+
labels: ""
6+
assignees: ""
87
---
98

109
🚨 Please do **not** open an issue for support questions. Instead please search for similar issues or post on http://discourse.jupyter.org/c/questions. 🚨

CONTRIBUTING.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,20 @@ The repo2docker developer documentation is all rendered on our documentation web
88
If you're here, you're probably looking for the [Contributing to repo2docker development](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html) page.
99

1010
Please make sure you've read the following sections before opening an issue/pull request:
11-
* [Process for making a contribution](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html#process-for-making-a-contribution).
12-
* These steps talk you through choosing the right issue template (bug report or feature request) and making a change.
13-
* [Guidelines to getting a Pull Request merged](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html#guidelines-to-getting-a-pull-request-merged).
14-
* These are tips and tricks to help make your contribution as smooth as possible for you and for the repo2docker maintenance team.
11+
12+
- [Process for making a contribution](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html#process-for-making-a-contribution).
13+
- These steps talk you through choosing the right issue template (bug report or feature request) and making a change.
14+
- [Guidelines to getting a Pull Request merged](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html#guidelines-to-getting-a-pull-request-merged).
15+
- These are tips and tricks to help make your contribution as smooth as possible for you and for the repo2docker maintenance team.
1516

1617
There are a few other pages to highlight:
1718

18-
* [Our roadmap](https://repo2docker.readthedocs.io/en/latest/contributing/roadmap.html)
19-
* We use the roadmap to develop a shared understanding of the project's vision and direction amongst the community of users, contributors, and maintainers.
19+
- [Our roadmap](https://repo2docker.readthedocs.io/en/latest/contributing/roadmap.html)
20+
- We use the roadmap to develop a shared understanding of the project's vision and direction amongst the community of users, contributors, and maintainers.
2021
This is a great place to get a feel for what the maintainers are thinking about for the short, medium, and long term future of the project.
21-
* [Design of repo2docker](https://repo2docker.readthedocs.io/en/latest/design.html)
22-
* This page explains some of the design principles behind repo2docker.
22+
- [Design of repo2docker](https://repo2docker.readthedocs.io/en/latest/design.html)
23+
- This page explains some of the design principles behind repo2docker.
2324
Its a good place to understand _why_ the team have made the decisions that they have along the way!
24-
* We absolutely encourage discussion around refactoring, updating or extending repo2docker, but please make sure that you've understood this page before opening an issue to discuss the change you'd like to propose.
25-
* [Common developer tasks and how-tos](https://repo2docker.readthedocs.io/en/latest/contributing/tasks.html)
26-
* Some notes on running tests, buildpack dependencies, creating a release, and keeping the pip files up to date.
25+
- We absolutely encourage discussion around refactoring, updating or extending repo2docker, but please make sure that you've understood this page before opening an issue to discuss the change you'd like to propose.
26+
- [Common developer tasks and how-tos](https://repo2docker.readthedocs.io/en/latest/contributing/tasks.html)
27+
- Some notes on running tests, buildpack dependencies, creating a release, and keeping the pip files up to date.

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ For more information, please visit
3131
---
3232

3333
## Using repo2docker
34+
3435
### Prerequisites
3536

3637
1. Docker to build & run the repositories. The [community edition](https://store.docker.com/search?type=edition&offering=community)
@@ -83,21 +84,19 @@ something like:
8384
If you copy paste that URL into your browser you will see a Jupyter Notebook
8485
with the contents of the repository you had just built!
8586

86-
For more information on how to use ``repo2docker``, see the
87+
For more information on how to use `repo2docker`, see the
8788
[usage guide](http://repo2docker.readthedocs.io/en/latest/usage.html).
8889

89-
9090
## Repository specifications
9191

9292
Repo2Docker looks for configuration files in the source repository to
9393
determine how the Docker image should be built. For a list of the configuration
94-
files that ``repo2docker`` can use, see the
94+
files that `repo2docker` can use, see the
9595
[complete list of configuration files](https://repo2docker.readthedocs.io/en/latest/config_files.html).
9696

9797
The philosophy of repo2docker is inspired by
9898
[Heroku Build Packs](https://devcenter.heroku.com/articles/buildpacks).
9999

100-
101100
## Docker Image
102101

103102
Repo2Docker can be run inside a Docker container if access to the Docker Daemon is provided, for example see [BinderHub](https://github.com/jupyterhub/binderhub). Docker images are [published to quay.io](https://quay.io/repository/jupyterhub/repo2docker?tab=tags). The old [Docker Hub image](https://hub.docker.com/r/jupyter/repo2docker) is no longer supported.

docs/source/architecture.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This is a living document talking about the architecture of repo2docker
44
from various perspectives.
55

66
(buildpacks)=
7+
78
## Buildpacks
89

910
The **buildpack** concept comes from [Heroku](https://devcenter.heroku.com/articles/buildpacks)
@@ -57,19 +58,19 @@ and basic notebook packages (from `repo2docker/buildpacks/conda/environment.yml`
5758
to be the same for most repositories built with `CondaBuildPack`, so we want to use
5859
[docker layer caching](https://thenewstack.io/understanding-the-docker-cache-for-faster-builds/) as
5960
much as possible for performance reasons. Next time a repository is built with `CondaBuildPack`,
60-
we can skip straight to the **copy** step (since the base environment docker image *layers* have
61+
we can skip straight to the **copy** step (since the base environment docker image _layers_ have
6162
already been built and cached).
6263

6364
The `get_build_scripts` and `get_build_script_files` methods are primarily used for this.
6465
`get_build_scripts` can return arbitrary bash script lines that can be run as different users,
6566
and `get_build_script_files` is used to copy specific scripts (such as a conda installer) into
6667
the image to be run as pat of `get_build_scripts`. Code in either has following constraints:
6768

68-
1. You can *not* use the contents of repository in them, since this happens before the repository
69+
1. You can _not_ use the contents of repository in them, since this happens before the repository
6970
is copied into the image. For example, `pip install -r requirements.txt` will not work,
7071
since there's no `requirements.txt` inside the image at this point. This is an explicit
7172
design decision, to enable better layer caching.
72-
2. You *may*, however, read the contents of the repository and modify the scripts emitted based
73+
2. You _may_, however, read the contents of the repository and modify the scripts emitted based
7374
on that! For example, in `CondaBuildPack`, if there's Python 2 specified in `environment.yml`,
7475
a different kind of environment is set up. The reading of the `environment.yml` is performed
7576
in the BuildPack itself, and not in the scripts returned by `get_build_scripts`. This is fine.
@@ -118,20 +119,19 @@ a path to a repository. This might be a local path or a URL. Upon being called,
118119
`repo2docker` will loop through all ContentProviders and perform the following
119120
commands:
120121

121-
* Run the `detect()` method on the repository path given to `repo2docker`. This
122+
- Run the `detect()` method on the repository path given to `repo2docker`. This
122123
should return any value other than `None` if the path matches what the ContentProvider is looking
123124
for.
124125

125126
> For example, the [`Local` ContentProvider](https://github.com/jupyterhub/repo2docker/blob/80b979f8580ddef184d2ba7d354e7a833cfa38a4/repo2docker/contentproviders/base.py#L64)
126127
> checks whether the argument is a valid local path. If so, then `detect(`
127128
> returns a dictionary: `{'path': source}` which defines the path to the repository.
128129
> This path is used by `fetch()` to check that it matches the output directory.
129-
* If `detect()` returns something other than `None`, run `fetch()` with the
130+
131+
- If `detect()` returns something other than `None`, run `fetch()` with the
130132
returned value as its argument. This should
131133
result in the contents of the repository being placed locally to a folder.
132134

133135
For more information on ContentProviders, take a look at
134136
[the ContentProvider base class](https://github.com/jupyterhub/repo2docker/blob/80b979f8580ddef184d2ba7d354e7a833cfa38a4/repo2docker/contentproviders/base.py#L16-L60)
135137
which has more explanation.
136-
137-

0 commit comments

Comments
 (0)