-
-
Notifications
You must be signed in to change notification settings - Fork 143
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #617 from openml/develop
[WIP] New release
- Loading branch information
Showing
71 changed files
with
5,770 additions
and
3,284 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| set -euo pipefail | ||
|
|
||
| # Check if DOCPUSH is set | ||
| if ! [[ -z ${DOCPUSH+x} ]]; then | ||
|
|
||
| if [[ "$DOCPUSH" == "true" ]]; then | ||
|
|
||
| # install documentation building dependencies | ||
| pip install matplotlib seaborn sphinx pillow sphinx-gallery sphinx_bootstrap_theme cython numpydoc nbformat nbconvert | ||
|
|
||
| # $1 is the branch name | ||
| # $2 is the global variable where we set the script status | ||
|
|
||
| if ! { [ $1 = "master" ] || [ $1 = "develop" ]; }; then | ||
| { echo "Not one of the allowed branches"; exit 0; } | ||
| fi | ||
|
|
||
| # delete any previous documentation folder | ||
| if [ -d doc/$1 ]; then | ||
| rm -rf doc/$1 | ||
| fi | ||
|
|
||
| # create the documentation | ||
| cd doc && make html 2>&1 | ||
|
|
||
| # create directory with branch name | ||
| # the documentation for dev/stable from git will be stored here | ||
| mkdir $1 | ||
|
|
||
| # get previous documentation from github | ||
| git clone https://github.com/openml/openml-python.git --branch gh-pages --single-branch | ||
|
|
||
| # copy previous documentation | ||
| cp -r openml-python/. $1 | ||
| rm -rf openml-python | ||
|
|
||
| # if the documentation for the branch exists, remove it | ||
| if [ -d $1/$1 ]; then | ||
| rm -rf $1/$1 | ||
| fi | ||
|
|
||
| # copy the updated documentation for this branch | ||
| mkdir $1/$1 | ||
| cp -r build/html/. $1/$1 | ||
|
|
||
| # takes a variable name as an argument and assigns the script outcome to a | ||
| # variable with the given name. If it got this far, the script was successful | ||
| function set_return() { | ||
| # $1 is the variable where we save the script outcome | ||
| local __result=$1 | ||
| local status='success' | ||
| eval $__result="'$status'" | ||
| } | ||
|
|
||
| set_return "$2" | ||
| fi | ||
| fi | ||
| # Workaround for travis failure | ||
| set +u |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| #!/bin/bash | ||
|
|
||
| # Inspired from https://github.com/scikit-learn/scikit-learn/blob/master/build_tools/travis/flake8_diff.sh | ||
|
|
||
| # This script is used in Travis to check that PRs do not add obvious | ||
| # flake8 violations. It relies on two things: | ||
| # - find common ancestor between branch and | ||
| # openml/openml-python remote | ||
| # - run flake8 --diff on the diff between the branch and the common | ||
| # ancestor | ||
| # | ||
| # Additional features: | ||
| # - the line numbers in Travis match the local branch on the PR | ||
| # author machine. | ||
| # - ./ci_scripts/flake8_diff.sh can be run locally for quick | ||
| # turn-around | ||
|
|
||
| set -e | ||
| # pipefail is necessary to propagate exit codes | ||
| set -o pipefail | ||
|
|
||
| PROJECT=openml/openml-python | ||
| PROJECT_URL=https://github.com/$PROJECT.git | ||
|
|
||
| # Find the remote with the project name (upstream in most cases) | ||
| REMOTE=$(git remote -v | grep $PROJECT | cut -f1 | head -1 || echo '') | ||
|
|
||
| # Add a temporary remote if needed. For example this is necessary when | ||
| # Travis is configured to run in a fork. In this case 'origin' is the | ||
| # fork and not the reference repo we want to diff against. | ||
| if [[ -z "$REMOTE" ]]; then | ||
| TMP_REMOTE=tmp_reference_upstream | ||
| REMOTE=$TMP_REMOTE | ||
| git remote add $REMOTE $PROJECT_URL | ||
| fi | ||
|
|
||
| echo "Remotes:" | ||
| echo '--------------------------------------------------------------------------------' | ||
| git remote --verbose | ||
|
|
||
| # Travis does the git clone with a limited depth (50 at the time of | ||
| # writing). This may not be enough to find the common ancestor with | ||
| # $REMOTE/develop so we unshallow the git checkout | ||
| if [[ -a .git/shallow ]]; then | ||
| echo -e '\nTrying to unshallow the repo:' | ||
| echo '--------------------------------------------------------------------------------' | ||
| git fetch --unshallow | ||
| fi | ||
|
|
||
| if [[ "$TRAVIS" == "true" ]]; then | ||
| if [[ "$TRAVIS_PULL_REQUEST" == "false" ]] | ||
| then | ||
| # In main repo, using TRAVIS_COMMIT_RANGE to test the commits | ||
| # that were pushed into a branch | ||
| if [[ "$PROJECT" == "$TRAVIS_REPO_SLUG" ]]; then | ||
| if [[ -z "$TRAVIS_COMMIT_RANGE" ]]; then | ||
| echo "New branch, no commit range from Travis so passing this test by convention" | ||
| exit 0 | ||
| fi | ||
| COMMIT_RANGE=$TRAVIS_COMMIT_RANGE | ||
| fi | ||
| else | ||
| # We want to fetch the code as it is in the PR branch and not | ||
| # the result of the merge into develop. This way line numbers | ||
| # reported by Travis will match with the local code. | ||
| LOCAL_BRANCH_REF=travis_pr_$TRAVIS_PULL_REQUEST | ||
| # In Travis the PR target is always origin | ||
| git fetch origin pull/$TRAVIS_PULL_REQUEST/head:refs/$LOCAL_BRANCH_REF | ||
| fi | ||
| fi | ||
|
|
||
| # If not using the commit range from Travis we need to find the common | ||
| # ancestor between $LOCAL_BRANCH_REF and $REMOTE/develop | ||
| if [[ -z "$COMMIT_RANGE" ]]; then | ||
| if [[ -z "$LOCAL_BRANCH_REF" ]]; then | ||
| LOCAL_BRANCH_REF=$(git rev-parse --abbrev-ref HEAD) | ||
| fi | ||
| echo -e "\nLast 2 commits in $LOCAL_BRANCH_REF:" | ||
| echo '--------------------------------------------------------------------------------' | ||
| git --no-pager log -2 $LOCAL_BRANCH_REF | ||
|
|
||
| REMOTE_DEV_REF="$REMOTE/develop" | ||
| # Make sure that $REMOTE_DEV_REF is a valid reference | ||
| echo -e "\nFetching $REMOTE_DEV_REF" | ||
| echo '--------------------------------------------------------------------------------' | ||
| git fetch $REMOTE develop:refs/remotes/$REMOTE_DEV_REF | ||
| LOCAL_BRANCH_SHORT_HASH=$(git rev-parse --short $LOCAL_BRANCH_REF) | ||
| REMOTE_DEV_SHORT_HASH=$(git rev-parse --short $REMOTE_DEV_REF) | ||
|
|
||
| COMMIT=$(git merge-base $LOCAL_BRANCH_REF $REMOTE_DEV_REF) || \ | ||
| echo "No common ancestor found for $(git show $LOCAL_BRANCH_REF -q) and $(git show $REMOTE_DEV_REF -q)" | ||
|
|
||
| if [ -z "$COMMIT" ]; then | ||
| exit 1 | ||
| fi | ||
|
|
||
| COMMIT_SHORT_HASH=$(git rev-parse --short $COMMIT) | ||
|
|
||
| echo -e "\nCommon ancestor between $LOCAL_BRANCH_REF ($LOCAL_BRANCH_SHORT_HASH)"\ | ||
| "and $REMOTE_DEV_REF ($REMOTE_DEV_SHORT_HASH) is $COMMIT_SHORT_HASH:" | ||
| echo '--------------------------------------------------------------------------------' | ||
| git --no-pager show --no-patch $COMMIT_SHORT_HASH | ||
|
|
||
| COMMIT_RANGE="$COMMIT_SHORT_HASH..$LOCAL_BRANCH_SHORT_HASH" | ||
|
|
||
| if [[ -n "$TMP_REMOTE" ]]; then | ||
| git remote remove $TMP_REMOTE | ||
| fi | ||
|
|
||
| else | ||
| echo "Got the commit range from Travis: $COMMIT_RANGE" | ||
| fi | ||
|
|
||
| echo -e '\nRunning flake8 on the diff in the range' "$COMMIT_RANGE" \ | ||
| "($(git rev-list $COMMIT_RANGE | wc -l) commit(s)):" | ||
| echo '--------------------------------------------------------------------------------' | ||
| # We need the following command to exit with 0 hence the echo in case | ||
| # there is no match | ||
| MODIFIED_FILES="$(git diff --name-only $COMMIT_RANGE || echo "no_match")" | ||
|
|
||
| check_files() { | ||
| files="$1" | ||
| shift | ||
| options="$*" | ||
| if [ -n "$files" ]; then | ||
| # Conservative approach: diff without context (--unified=0) so that code | ||
| # that was not changed does not create failures | ||
| git diff --unified=0 $COMMIT_RANGE -- $files | flake8 --ignore E402 --diff --show-source $options | ||
| fi | ||
| } | ||
|
|
||
| if [[ "$MODIFIED_FILES" == "no_match" ]]; then | ||
| echo "No file has been modified" | ||
| else | ||
|
|
||
| check_files "$(echo "$MODIFIED_FILES" | grep -v ^examples)" | ||
| check_files "$(echo "$MODIFIED_FILES" | grep ^examples)" \ | ||
| --config ./examples/.flake8 | ||
| fi | ||
| echo -e "No problem detected by flake8\n" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.