Merge branch 'master' into help

Author: minrk

.circleci/config.yml

@@ -15,6 +15,7 @@ jobs:
       - restore_cache:
           keys:
             - cache-pip
+      - run: pip install --user -e .
       # Install the packages needed to build our documentation
       # This will depend on your particular package!
       - run: pip install --user -r docs/doc-requirements.txt

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us repair something that is currently broken
+title: ''
+labels: ''
+assignees: ''
+
+---
+<!-- 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! -->
+
+### Bug description
+<!-- Use this section to clearly and concisely describe the bug. -->
+
+#### Expected behaviour
+<!-- Tell us what you thought would happen. -->
+
+#### Actual behaviour
+<!-- Tell us what you actually happens. -->
+
+### How to reproduce
+<!-- Use this section to describe the steps that a user would take to experience this bug. -->
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Your personal set up
+<!-- 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. -->
+
+ - OS: [e.g. linux, OSX]
+ - Docker version: `docker version` <!-- Run this command to get your version. -->
+ - repo2docker version `repo2docker --version` <!-- Run this command to get your version. -->
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,29 @@
+---
+name: Feature request
+about: Suggest a new feature or a big change to repo2docker
+title: ''
+labels: 'needs: discussion'
+assignees: ''
+
+---
+<!-- 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! -->
+
+### Proposed change
+<!-- Use this section to describe the feature you'd like to be added. -->
+
+
+### Alternative options
+<!-- Use this section to describe alternative options and why you've decided on the proposed feature above. -->
+
+
+### Who would use this feature?
+<!-- Describe the audience for this feature. This information will affect who chooses to work on the feature with you. -->
+
+
+### How much effort will adding it take?
+<!-- Try to estimate how much work adding this feature will require. This information will affect who chooses to work on the feature with you. -->
+
+
+### Who can do this work?
+<!-- 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

@@ -0,0 +1,14 @@
+---
+name: Support question
+about: Ask a question about using repo2docker
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+🚨 Please do **not** open an issue for support questions. Instead please search for similar issues or post on http://discourse.jupyter.org/c/questions. 🚨
+
+More people read the forum than this issue tracker, it is indexed by search engines and easier for others to discover.
+
+For more details: https://discourse.jupyter.org/t/a-proposal-for-jupyterhub-communications/505

.gitignore

@@ -21,6 +21,12 @@ lib64/
 share/
 include/
 
+# PyTest remnants
+tests/dockerfile/legacy/._binder.Dockerfile
+tests/dockerfile/legacy/apt-sources.list
+tests/dockerfile/legacy/python3.frozen.yml
+tests/dockerfile/legacy/root.frozen.yml
+
 # Docs
 generated/
 test_file_text.txt

.pre-commit-config.yaml

@@ -0,0 +1,5 @@
+repos:
+- repo: https://github.com/ambv/black
+  rev: 18.9b0
+  hooks:
+  - id: black

.travis.yml

@@ -1,3 +1,4 @@
+dist: xenial
 language: python
 sudo: required
 cache: pip
@@ -12,41 +13,50 @@ install:
 - pip install -r dev-requirements.txt
 - python setup.py bdist_wheel
 - pip install dist/*.whl
+- pip freeze
 script:
-# cd into tests so CWD being repo2docker does not hide
-# possible issues with MANIFEST.in
-- pushd tests;
-  if [ ${REPO_TYPE} == "r" ] || [ ${REPO_TYPE} == "stencila-r" ] || [ ${REPO_TYPE} == "stencila-py" ]; then
-    travis_wait 30 pytest --durations 10 --cov repo2docker -v ${REPO_TYPE} || exit 1;
-  else
-    travis_retry pytest --durations 10 --cov repo2docker -v ${REPO_TYPE} || exit 1;
-  fi;
-  popd;
-- pip install -r docs/doc-requirements.txt
-- pushd docs;
-  make html || exit 1;
-  popd;
+- |
+  # run autoformat
+  if [[ "$REPO_TYPE" == "lint" ]]; then
+    pre-commit run --all-files
+  fi
+- |
+  # run any of the other tests
+  if [[ "$REPO_TYPE" != "lint" ]]; then
+    # cd into tests so CWD being repo2docker does not hide
+    # possible issues with MANIFEST.in
+    pushd tests;
+    if [ ${REPO_TYPE} == "r" ] || [ ${REPO_TYPE} == "stencila-r" ] || [ ${REPO_TYPE} == "stencila-py" ]; then
+      travis_wait 30 pytest --durations 10 --cov repo2docker -v ${REPO_TYPE} || exit 1;
+    else
+      travis_retry pytest --durations 10 --cov repo2docker -v ${REPO_TYPE} || exit 1;
+    fi;
+    popd;
+  fi
 after_success:
 - pip install codecov
 - pushd tests && codecov && popd
-jobs:
-  include:
-  - stage: deploy
-    script: skip
-    if: type = push
-    env:
-    - REPO_TYPE=
-    deploy:
-      provider: script
-      script: "./travis/travis-script.bash"
-      on:
-        tags: true
-        branch: master
+
+after_failure:
+- |
+  # point to auto-lint-fix
+  if [[ "$REPO_TYPE" == "lint" ]]; then
+    echo "You can install pre-commit hooks to automatically run formatting"
+    echo "on each commit with:"
+    echo "    pre-commit install"
+    echo "or you can run by hand on staged files with"
+    echo "    pre-commit run"
+    echo "or after-the-fact on already committed files with"
+    echo "    pre-commit run --all-files"
+  fi
+
 env:
   matrix:
+  - REPO_TYPE=lint
   - REPO_TYPE=unit
   - REPO_TYPE=base
   - REPO_TYPE=conda
+  - REPO_TYPE=pipfile
   - REPO_TYPE=venv
   - REPO_TYPE=stencila-r
   - REPO_TYPE=stencila-py
@@ -61,7 +71,7 @@ env:
   - secure: KoOOJUp60vtvx/mXzoZWpvWgB6W3rr8I0gDWL2laCTgxo6HsTL+SSOY1l12SBE2jlvFmQqVwPPBfnp5Dudna2RQFF36eO2jUlISBkvK/q/GRmOQbjpAJRtVlan8Z4dlIf4az/oQ9G0ZUEfgUliVvS5MTrEPvKej3znug2zAH1t+H0U6aon1VJeVC+b94jsETGvQ7HHupqrr+DNGrNVHOgAazw7z4j+VtfZyfNaglnrKwYPeUljw3GIOXyFmP81t/cLiDY+IjPPepUYJFQIjCoVpIDm6UR70d4mzWf/LYWONEdh8LhDJZ2UyEtnUT2IPTdhqem1BfCAKUcLedHPk3S4Lcn0jL23os0klHeQvn9JRPEDV/Ib33XGcNEIXZi0pBkluUyhx8JgTz4e+KL8jKcyf9TRX7o/ViH7Ler6viliyMu15yfs2mJKAxzw6GFMtqGzhJ8tUXjguTozfjKTJKjBpkFoYdYbO9GqNkBQo2F7H+8zAmb4D4K0jzfOo8owjYLXJzOMJN5f5pKBqfLdjOtTxve4PrCgy4B8x7GDkW41SuRz2pkVwRDMMJRCetLcbqpEK+8b9Oy/inlxt7/56oS/tvvAtBj2FlLGBPQJKpwyZozIY9XqXWu8u+VbRsSTqbRtdSHzzKyQ25a03dc7KDHmyoDAlzyehe6cHPWp1UqXg=
 matrix:
   include:
-  - python: 3.4
+  - python: 3.5
     env:
     - REPO_TYPE=venv
 deploy:

CONTRIBUTING.md

@@ -1,7 +1,26 @@
 # Contributing to repo2docker development
 
-The repo2docker developer documentation can be found on these pages:
+:sparkles: Thank you for thinking about contributing to repo2docker! :sparkles:
+
+(And thank you particularly for coming to read the guidelines! :heart_eyes:)
+
+The repo2docker developer documentation is all rendered on our documentation website: [https://repo2docker.readthedocs.io](https://repo2docker.readthedocs.io).
+If you're here, you're probably looking for the [Contributing to repo2docker development](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html) page.
+
+Please make sure you've read the following sections before opening an issue/pull request:
+* [Process for making a contribution](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html#process-for-making-a-contribution).
+  * These steps talk you through choosing the right issue template (bug report or feature request) and making a change.
+* [Guidelines to getting a Pull Request merged](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html#guidelines-to-getting-a-pull-request-merged).
+  * These are tips and tricks to help make your contribution as smooth as possible for you and for the repo2docker maintenance team.
+
+There are a few other pages to highlight:
 
-* [Contributing to repo2docker](https://repo2docker.readthedocs.io/en/latest/contributing/contributing.html)
 * [Our roadmap](https://repo2docker.readthedocs.io/en/latest/contributing/roadmap.html)
+  * We use the roadmap to develop a shared understanding of the project's vision and direction amongst the community of users, contributors, and maintainers.
+    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.
+* [Design of repo2docker](https://repo2docker.readthedocs.io/en/latest/design.html)
+  * This page explains some of the design principles behind repo2docker.
+    Its a good place to understand _why_ the team have made the decisions that they have along the way!
+  * 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.
 * [Common developer tasks and how-tos](https://repo2docker.readthedocs.io/en/latest/contributing/tasks.html)
+  * Some notes on running tests, buildpack dependencies, creating a release, updating the changelog and keeping the pip files up to date.

Dockerfile

@@ -1,9 +1,30 @@
-FROM python:3.6.3
+ARG ALPINE_VERSION=3.9.4
+FROM alpine:${ALPINE_VERSION}
+
+RUN apk add --no-cache git python3 python3-dev
+
+# build wheels in first image
+ADD . /tmp/src
+RUN cd /tmp/src && git clean -xfd && git status
+RUN mkdir /tmp/wheelhouse \
+ && cd /tmp/wheelhouse \
+ && pip3 install wheel \
+ && pip3 wheel --no-cache-dir /tmp/src \
+ && ls -l /tmp/wheelhouse
+
+FROM alpine:${ALPINE_VERSION}
+
+# install python, git, bash
+RUN apk add --no-cache git git-lfs python3 bash
+
+# install repo2docker
+COPY --from=0 /tmp/wheelhouse /tmp/wheelhouse
+RUN pip3 install --no-cache-dir /tmp/wheelhouse/*.whl \
+ && pip3 list
+
+# add git-credential helper
+COPY ./docker/git-credential-env /usr/local/bin/git-credential-env
+RUN git config --system credential.helper env
 
 # Used for testing purpose in ports.py
 EXPOSE 52000
-RUN mkdir /tmp/src
-ADD . /tmp/src
-RUN pip3 install --no-cache-dir /tmp/src
-RUN cp /tmp/src/docker/git-credential-env /usr/local/bin/git-credential-env && \
-    git config --system credential.helper env

Pipfile

@@ -3,14 +3,15 @@
 # update these accordingly
 
 [dev-packages]
-pytest="*"
+pytest=">=3.6"
 wheel="*"
 pytest-cov="*"
 PyYAML = "*"
 recommonmark = "*"
 alabaster = "*"
 Sphinx = ">=1.4,!=1.5.4"
 alabaster_jupyterhub = "*"
+sphinxcontrib-autoprogram = "*"
 
 [packages]
 repo2docker = {path=".", editable=true}