Skip to content

Commit

Permalink
Merge branch 'master' into issue-861
Browse files Browse the repository at this point in the history
Resolved conflicts between local branch and updates to the upstream
master.
  • Loading branch information
echowhisky committed May 6, 2019
2 parents 40c5c07 + 2662627 commit 167c686
Show file tree
Hide file tree
Showing 35 changed files with 10,689 additions and 32 deletions.
46 changes: 39 additions & 7 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,44 @@
dist: xenial
language: python
python:
- 3.6
- 3.7
sudo: required
services:
- docker
install:
- make dev-env
script:
- set -e
- make test/docs docs
- make build-test-all DARGS="--build-arg TEST_ONLY_BUILD=1"

jobs:
include:
- stage: diff-test
install:
- pip install --upgrade pip
- make dev-env
script:
- set -e
- if [ $(make n-docs-diff) -ne 0 ]; then make docs; fi;
- if [ $(make n-other-diff) -ne 0 ]; then make build-test-all DARGS="--build-arg TEST_ONLY_BUILD=1"; fi;
- stage: push-tx
install:
- pip install --upgrade pip
- make dev-env
script:
- if [ $(make n-docs-diff DIFF_RANGE=$TRAVIS_COMMIT_RANGE) -ne 0 ]; then make tx-en; fi;
- stage: full-test
install:
- pip install --upgrade pip
- make dev-env
script:
- set -e
- make docs
- make build-test-all DARGS="--build-arg TEST_ONLY_BUILD=1"

stages:
- name: diff-test
if: type = pull_request
- name: push-tx
if: type = push AND branch = master
- name: full-test
if: type = cron AND branch = master

env:
global:
secure: JDQKgB1laaenzmEGI9gduwK/iS0030qsl62njJg3jib0R8wxBi2OeetEdoGl9m4NFsqqnp0OO7nm4rzGfuwjL1A38flSlXOTxhjm/hvo3vmnqVu5lDcdk9+IRkafnfd3Dyd86tLxRVETOqZwCLmdNkB2fmQII8du5IIqbJuUGp8DrG7kVMf3NBr9rjkZRfByQrgG4s1NXuT61VvpWMPJAOhcrImuHBheVJDEV0U3n6Xavd7Wo+pAHrHU8exvYTZ1IzZMbHc6K0iC/NpCHcH9+9DAeLDk/q1aDNqbTExnQevOHZzNqgHC2qFOlN4jfy/TLYLpLXtUismneBBqVSK3iZso3Vqy2BRXWgouI+Tt+08ffocy9XPwEzSwkgPgDlFVUikPOy5imwjpDb13RMIyMY4CKlSOdQx2rH2kPkZ0MJJPcki3KGuGl3qRvqyblMn+lZvjAu6WVLZfo7EtcxsQ0ZZxbAbGoUVl27FHg+UvIfC0I3wEcZIp7oED47Q8s0MdCijD3AwkRPvx/iyp3J0A42su7kkOooFcmUItEIqegQJ4Aki1FBv2i5vHmBobClktytZceLsKvzCeLjMpL9HcUVfUaJDKRwtUYIozpYeBnac+E6J1s6glcqLrXIHWez8N6SzokBa6SPqdtODdzzk5OJupByub6CYWsRXvxIQ7/wI=
24 changes: 22 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
SHELL:=bash
OWNER:=jupyter
ARCH:=$(shell uname -m)
DIFF_RANGE?=master...HEAD

# Need to list the images in build dependency order
ifeq ($(ARCH),ppc64le)
Expand Down Expand Up @@ -60,8 +61,27 @@ dev-env: ## install libraries required to build docs and run tests
docs: ## build HTML documentation
make -C docs html

test/docs: ## check links in Sphinx documentation
make -C docs
n-docs-diff: ## number of docs/ files changed since branch from master
@git diff --name-only $(DIFF_RANGE) -- docs/ ':!docs/locale' | wc -l | awk '{print $$1}'


n-other-diff: ## number of files outside docs/ changed since branch from master
@git diff --name-only $(DIFF_RANGE) -- ':!docs/' | wc -l | awk '{print $$1}'

tx-en: ## rebuild en locale strings and push to master (req: GH_TOKEN)
@git config --global user.email "[email protected]"
@git config --global user.name "Travis CI"
@git checkout master

@make -C docs clean gettext
@cd docs && sphinx-intl update -p _build/gettext -l en

@git add docs/locale/en
@git commit -m "[ci skip] Update en source strings (build: $$TRAVIS_JOB_NUMBER)"

@git remote add origin-tx https://$${GH_TOKEN}@github.com/jupyter/docker-stacks.git
@git push -u origin-tx master


test/%: ## run tests against a stack
@TEST_IMAGE="$(OWNER)/$(notdir $@)" pytest test
Expand Down
3 changes: 2 additions & 1 deletion base-notebook/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ RUN cd /tmp && \
$CONDA_DIR/bin/conda config --system --set show_channel_urls true && \
$CONDA_DIR/bin/conda install --quiet --yes conda="${CONDA_VERSION%.*}.*" && \
$CONDA_DIR/bin/conda update --all --quiet --yes && \
conda list python | grep '^python ' | tr -s ' ' | cut -d '.' -f 1,2 | sed 's/$/.*/' >> $CONDA_DIR/conda-meta/pinned && \
conda clean --all -f -y && \
rm -rf /home/$NB_USER/.cache/yarn && \
fix-permissions $CONDA_DIR && \
Expand All @@ -100,7 +101,7 @@ RUN conda install --quiet --yes 'tini=0.18.0' && \
RUN conda install --quiet --yes \
'notebook=5.7.8' \
'jupyterhub=0.9.6' \
'jupyterlab=0.35.4' && \
'jupyterlab=0.35.5' && \
conda clean --all -f -y && \
jupyter labextension install @jupyterlab/hub-extension@^0.12.0 && \
npm cache clean --force && \
Expand Down
4 changes: 4 additions & 0 deletions base-notebook/hooks/post_checkout
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/bash
if [[ "$COMMIT_MSG" = *"skip ci"* || "$COMMIT_MSG" = *"ci skip"* ]]; then
exit 1;
fi
27 changes: 27 additions & 0 deletions docs/.tx/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
[main]
host = https://www.transifex.com

[jupyter-docker-stacks-1.using-po--master]
file_filter = locale/<lang>/LC_MESSAGES/using.po
source_file = locale/en/LC_MESSAGES/using.po
source_lang = en
type = PO

[jupyter-docker-stacks-1.maintaining-po--master]
file_filter = locale/<lang>/LC_MESSAGES/maintaining.po
source_file = locale/en/LC_MESSAGES/maintaining.po
source_lang = en
type = PO

[jupyter-docker-stacks-1.index-po--master]
file_filter = locale/<lang>/LC_MESSAGES/index.po
source_file = locale/en/LC_MESSAGES/index.po
source_lang = en
type = PO

[jupyter-docker-stacks-1.contributing-po--master]
file_filter = locale/<lang>/LC_MESSAGES/contributing.po
source_file = locale/en/LC_MESSAGES/contributing.po
source_lang = en
type = PO

11 changes: 8 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@

# General information about the project.
project = 'docker-stacks'
copyright = '2018, Project Jupyter'
copyright = '2018- Project Jupyter'
author = 'Project Jupyter'

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -191,7 +191,12 @@
'Miscellaneous'),
]

# -- Extension configuration -------------------------------------------------
# -- Extension configuration ----------------------------------------------

# Anchors are often dynamic
linkcheck_anchors = False
linkcheck_anchors = False

# -- Translation ----------------------------------------------------------

gettext_uuid = True
locale_dirs = ['locale/']
2 changes: 1 addition & 1 deletion docs/contributing/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Thank you for contributing to the Jupyter Docker Stacks! We review pull requests
Please follow the process below to suggest a new feature for inclusion in one of the core stacks:

1. [Open a GitHub issue](https://github.com/jupyter/docker-stacks/issues) describing the feature you'd like to contribute.
2. Discuss with the maintainers whether the addition makes sense in [one of the core stacks](../using/selecting.html#Core-Stacks), as a [recipe in the documentation](recipes.html), as a [community stack](stacks.html), or as something else entirely.
2. Discuss with the maintainers whether the addition makes sense in [one of the core stacks](../using/selecting.md#Core-Stacks), as a [recipe in the documentation](recipes.md), as a [community stack](stacks.md), or as something else entirely.

## Selection Criteria

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/recipes.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# New Recipes

We welcome contributions of [recipes](../using/recipes.html), short examples of using, configuring, or extending the Docker Stacks, for inclusion in the documentation site. Follow the process below to add a new recipe:
We welcome contributions of [recipes](../using/recipes.md), short examples of using, configuring, or extending the Docker Stacks, for inclusion in the documentation site. Follow the process below to add a new recipe:

1. Open the `docs/using/recipes.md` source file.
2. Add a second-level Markdown heading naming your recipe at the bottom of the file (e.g., `## Add the RISE extension``)
2. Add a second-level Markdown heading naming your recipe at the bottom of the file (e.g., `## Add the RISE extension`)
3. Write the body of your recipe under the heading, including whatever command line, Dockerfile, links, etc. you need.
4. [Submit a pull request](https://github.com/PointCloudLibrary/pcl/wiki/A-step-by-step-guide-on-preparing-and-submitting-a-pull-request) (PR) with your changes. Maintainers will respond and work with you to address any formatting or content issues.
2 changes: 1 addition & 1 deletion docs/contributing/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ We greatly appreciate pull requests that extend the automated tests that vet the

## How the Tests Work

Travis executes `make build-test-all` against every pull request submitted to the `jupyter/docker-stacks` repository. The `make` command builds every docker image. After building each image, the `make` command executes `pytest` to run both image-specific tests like those in [base-notebook/test/](https://github.com/jupyter/docker-stacks/tree/master/base-notebook/test) and common tests defined in [test/](https://github.com/jupyter/docker-stacks/tree/master/test). Both kinds of tests make use of global [pytest fixtures](https://docs.pytest.org/en/latest/fixture.html) defined in the [conftest.py](https://github.com/jupyter/docker-stacks/blob/master/conftest.py) file at the root of the projects.
Travis executes `make build-test-all` against pull requests submitted to the `jupyter/docker-stacks` repository. This `make` command builds every docker image. After building each image, the `make` command executes `pytest` to run both image-specific tests like those in [base-notebook/test/](https://github.com/jupyter/docker-stacks/tree/master/base-notebook/test) and common tests defined in [test/](https://github.com/jupyter/docker-stacks/tree/master/test). Both kinds of tests make use of global [pytest fixtures](https://docs.pytest.org/en/latest/fixture.html) defined in the [conftest.py](https://github.com/jupyter/docker-stacks/blob/master/conftest.py) file at the root of the projects.

## Contributing New Tests

Expand Down
7 changes: 7 additions & 0 deletions docs/contributing/translations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Doc Translations

We are delighted when members of the Jupyter community want to help translate these documentation pages to other languages. If you're interested, please visit links below below to join our team on [Transifex](https://transifex.com) and to start creating, reviewing, and updating translations of the Jupyter Docker Stacks documentation.

1. Follow the steps documented on the [Getting Started as a Translator](https://docs.transifex.com/getting-started-1/translators) page.
2. Look for *jupyter-docker-stacks* when prompted to choose a translation team. Alternatively, visit https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1 after creating your account and request to join the project.
3. See [Translating with the Web Editor](https://docs.transifex.com/translation/translating-with-the-web-editor) in the Transifex documentation.
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,10 @@ Table of Contents
:maxdepth: 2
:caption: Contributor Guide

contributing/issues
contributing/issues
contributing/packages
contributing/recipes
contributing/translations
contributing/tests
contributing/features
contributing/stacks
Expand Down
Loading

0 comments on commit 167c686

Please sign in to comment.