scikit-learn · thomasjpfan · Jun 1, 2022 · Sep 24, 2021 · Sep 24, 2021 · Sep 24, 2021
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,92 +1,42 @@
 version: 2.1
 
+# Parameters required to trigger the execution
+# of the "doc-min-dependencies" and "doc" jobs
+parameters:
+  GITHUB_RUN_URL:
+    type: string
+    default: "none"
+
 jobs:
   doc-min-dependencies:
     docker:
       - image: cimg/python:3.8.12
     environment:
-      - OMP_NUM_THREADS: 2
-      - MKL_NUM_THREADS: 2
-      - CONDA_ENV_NAME: testenv
-      - LOCK_FILE: build_tools/circle/doc_min_dependencies_linux-64_conda.lock
+      - GITHUB_ARTIFACT_URL: << pipeline.parameters.GITHUB_RUN_URL >>/doc-min-dependencies.zip
     steps:
       - checkout
-      - run: ./build_tools/circle/checkout_merge_commit.sh
-      - restore_cache:
-          key: v1-doc-min-deps-datasets-{{ .Branch }}
-      - restore_cache:
-          keys:
-            - doc-min-deps-ccache-{{ .Branch }}
-            - doc-min-deps-ccache
-      - run: ./build_tools/circle/build_doc.sh
-      - save_cache:
-          key: doc-min-deps-ccache-{{ .Branch }}-{{ .BuildNum }}
-          paths:
-            - ~/.ccache
-            - ~/.cache/pip
-      - save_cache:
-          key: v1-doc-min-deps-datasets-{{ .Branch }}
-          paths:
-            - ~/scikit_learn_data
+      - run: bash build_tools/circle/download_documentation.sh
       - store_artifacts:
           path: doc/_build/html/stable
           destination: doc
-      - store_artifacts:
-          path: ~/log.txt
-          destination: log.txt
 
   doc:
     docker:
       - image: cimg/python:3.8.12
     environment:
-      - OMP_NUM_THREADS: 2
-      - MKL_NUM_THREADS: 2
-      - CONDA_ENV_NAME: testenv
-      - LOCK_FILE: build_tools/circle/doc_linux-64_conda.lock
+      - GITHUB_ARTIFACT_URL: << pipeline.parameters.GITHUB_RUN_URL >>/doc.zip
     steps:
       - checkout
-      - run: ./build_tools/circle/checkout_merge_commit.sh
-      - restore_cache:
-          key: v1-doc-datasets-{{ .Branch }}
-      - restore_cache:
-          keys:
-            - doc-ccache-{{ .Branch }}
-            - doc-ccache
-      - run: ./build_tools/circle/build_doc.sh
-      - save_cache:
-          key: doc-ccache-{{ .Branch }}-{{ .BuildNum }}
-          paths:
-            - ~/.ccache
-            - ~/.cache/pip
-      - save_cache:
-          key: v1-doc-datasets-{{ .Branch }}
-          paths:
-            - ~/scikit_learn_data
+      - run: bash build_tools/circle/download_documentation.sh
       - store_artifacts:
           path: doc/_build/html/stable
           destination: doc
-      - store_artifacts:
-          path: ~/log.txt
-          destination: log.txt
-      # Persists generated documentation so that it can be attached and deployed
-      # in the 'deploy' step.
+      # Persists the generated documentation, so that it
+      # can be attached and deployed in the "deploy" job
       - persist_to_workspace:
           root: doc/_build/html
           paths: .
 
-  lint:
-    docker:
-      - image: cimg/python:3.8.12
-    steps:
-      - checkout
-      - run: ./build_tools/circle/checkout_merge_commit.sh
-      - run:
-          name: dependencies
-          command: pip install flake8
-      - run:
-          name: linting
-          command: ./build_tools/circle/linting.sh
-
   linux-arm64:
     machine:
       image: ubuntu-2004:202101-01
@@ -127,18 +77,23 @@ jobs:
 
 workflows:
   version: 2
+
   build-doc-and-deploy:
+    when:
+      not:
+        equal: [ "none", << pipeline.parameters.GITHUB_RUN_URL >> ]
+    # The jobs should run only when triggered by the workflow
     jobs:
-      - lint
-      - doc:
-          requires:
-            - lint
-      - doc-min-dependencies:
-          requires:
-            - lint
+      - doc-min-dependencies
+      - doc
       - deploy:
           requires:
             - doc
+
   linux-arm64:
+    when:
+      equal: [ "none", << pipeline.parameters.GITHUB_RUN_URL >> ]
+    # Prevent double execution of this job: on push
+    # by default and when triggered by the workflow
     jobs:
       - linux-arm64
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -0,0 +1,66 @@
+# Workflow to build the documentation
+name: Documentation builder
+
+on:
+  push:
+    branches:
+      - main
+      # Release branches
+      - "[0-9]+.[0-9]+.X"
+  pull_request:
+    branches:
+      - main
+      - "[0-9]+.[0-9]+.X"
+
+jobs:
+  # Build the documentation against the minimum version of the dependencies
+  doc-min-dependencies:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout scikit-learn
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+
+      - name: Build documentation
+        run: bash build_tools/github/build_doc.sh
+        env:
+          OMP_NUM_THREADS: 2
+          MKL_NUM_THREADS: 2
+          CONDA_ENV_NAME: testenv
+          LOCK_FILE: build_tools/github/doc_min_dependencies_linux-64_conda.lock
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v2
+        with:
+          name: doc-min-dependencies
+          path: doc/_build/html/stable
+
+  # Build the documentation against the latest version of the dependencies
+  doc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout scikit-learn
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+
+      - name: Build documentation
+        run: bash build_tools/github/build_doc.sh
+        env:
+          OMP_NUM_THREADS: 2
+          MKL_NUM_THREADS: 2
+          CONDA_ENV_NAME: testenv
+          LOCK_FILE: build_tools/github/doc_linux-64_conda.lock
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v2
+        with:
+          name: doc
+          path: doc/_build/html/stable
diff --git a/.github/workflows/trigger-hosting.yml b/.github/workflows/trigger-hosting.yml
@@ -0,0 +1,26 @@
+# Workflow to trigger the jobs that will host the documentation
+name: Documentation push trigger
+on:
+  workflow_run:
+    # Run the workflow after the separate "Documentation builder" workflow completes
+    workflows: [Documentation builder]
+    types:
+      - completed
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    # Run the job only if the "Documentation builder" workflow succeeded
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Checkout scikit-learn
+        uses: actions/checkout@v2
+
+      - name: Trigger hosting jobs
+        run: bash build_tools/github/trigger_hosting.sh
+        env:
+          CIRCLE_CI_TOKEN: ${{ secrets.CIRCLE_CI_TOKEN }}
+          EVENT: ${{ github.event.workflow_run.event }}
+          RUN_ID: ${{ github.event.workflow_run.id }}
+          HEAD_BRANCH: ${{ github.event.workflow_run.head_branch }}
+          PULL_REQUEST_NUMBER: ${{ github.event.workflow_run.pull_requests[0].number }}
diff --git a/build_tools/circle/download_documentation.sh b/build_tools/circle/download_documentation.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -e
+set -x
+
+wget $GITHUB_ARTIFACT_URL
+mkdir -p doc/_build/html/stable
+unzip doc*.zip -d doc/_build/html/stable
diff --git a/build_tools/circle/build_doc.sh → build_tools/github/build_doc.sh b/build_tools/circle/build_doc.sh → build_tools/github/build_doc.sh
@@ -17,6 +17,21 @@ set -e
 # If the inspection of the current commit fails for any reason, the default
 # behavior is to quick build the documentation.
 
+if [ -n "$GITHUB_ACTION" ]
+then
+    # Map the variables for the new documentation builder to the old one
+    CIRCLE_SHA1=$(git log --no-merges -1 --pretty=format:%H)
+    CIRCLE_JOB=$GITHUB_JOB
+
+    if [ "$GITHUB_EVENT_NAME" == "pull_request" ]
+    then
+        CIRCLE_BRANCH=$GITHUB_HEAD_REF
+        CI_PULL_REQUEST=true
+    else
+        CIRCLE_BRANCH=$GITHUB_REF_NAME
+    fi
+fi
+
 get_build_type() {
     if [ -z "$CIRCLE_SHA1" ]
     then

diff --git a/build_tools/circle/doc_environment.yml → build_tools/github/doc_environment.yml b/build_tools/circle/doc_environment.yml → build_tools/github/doc_environment.yml
diff --git a/build_tools/circle/doc_linux-64_conda.lock → build_tools/github/doc_linux-64_conda.lock b/build_tools/circle/doc_linux-64_conda.lock → build_tools/github/doc_linux-64_conda.lock
diff --git a/...rcle/doc_min_dependencies_environment.yml → ...thub/doc_min_dependencies_environment.yml b/...rcle/doc_min_dependencies_environment.yml → ...thub/doc_min_dependencies_environment.yml
diff --git a/.../doc_min_dependencies_linux-64_conda.lock → .../doc_min_dependencies_linux-64_conda.lock b/.../doc_min_dependencies_linux-64_conda.lock → .../doc_min_dependencies_linux-64_conda.lock
diff --git a/build_tools/github/trigger_hosting.sh b/build_tools/github/trigger_hosting.sh
@@ -0,0 +1,21 @@
+#!/bin/bash
+
+set -e
+set -x
+
+GITHUB_RUN_URL=https://nightly.link/$GITHUB_REPOSITORY/actions/runs/$RUN_ID
+
+if [ "$EVENT" == pull_request ]
+then
+     BRANCH=pull/$PULL_REQUEST_NUMBER/head
+else
+     BRANCH=$HEAD_BRANCH
+fi
+
+curl --request POST \
+     --url https://circleci.com/api/v2/project/gh/$GITHUB_REPOSITORY/pipeline \
+     --header "Circle-Token: $CIRCLE_CI_TOKEN" \
+     --header "content-type: application/json" \
+     --header "x-attribution-actor-id: github_actions" \
+     --header "x-attribution-login: github_actions" \
+     --data \{\"branch\":\"$BRANCH\",\"parameters\":\{\"GITHUB_RUN_URL\":\"$GITHUB_RUN_URL\"\}\}
diff --git a/build_tools/update_environments_and_lock_files.py b/build_tools/update_environments_and_lock_files.py
@@ -210,7 +210,7 @@ def remove_from(alist, to_remove):
     },
     {
         "build_name": "doc_min_dependencies",
-        "folder": "build_tools/circle",
+        "folder": "build_tools/github",
         "platform": "linux-64",
         "channel": "conda-forge",
         "conda_dependencies": common_dependencies_without_coverage
@@ -242,7 +242,7 @@ def remove_from(alist, to_remove):
     },
     {
         "build_name": "doc",
-        "folder": "build_tools/circle",
+        "folder": "build_tools/github",
         "platform": "linux-64",
         "channel": "conda-forge",
         "conda_dependencies": common_dependencies_without_coverage