config.yml

# See: https://circleci.com/blog/deploying-documentation-to-github-pages-with-continuous-integration/
version: 2.1

_check_skip: &check_skip
  name: Check-skip
  command: |
    set -e
    export COMMIT_MESSAGE=$(git log --format=oneline -n 1);
    if [[ -v CIRCLE_PULL_REQUEST ]] && ([[ "$COMMIT_MESSAGE" == *"[skip circle]"* ]] || [[ "$COMMIT_MESSAGE" == *"[circle skip]"* ]]); then
      echo "Skip detected, exiting job ${CIRCLE_JOB} for PR ${CIRCLE_PULL_REQUEST}."
      circleci-agent step halt;
    fi

jobs:
  docs-build:
    machine:
        image: default
    steps:
        - checkout

        - run:
            <<: *check_skip

        # restore cache from last build. Unless __init__.py has changed since then
        - restore_cache:
            keys:
              - data-cache-0-{{ checksum "./mne_bids/__init__.py" }}

        # Also restore pip cache to speed up installations
        - restore_cache:
            keys:
              - pip-cache-0-{{ checksum "./pyproject.toml" }}

        - run:
            name: Setup Python3 environment
            command: |
                python3 -m venv /home/circleci/mne_bids_env
                echo "source /home/circleci/mne_bids_env/bin/activate" >> $BASH_ENV

        - run:
            name: Install Python packages
            command: |
              python -m pip install --upgrade --progress-bar off pip
              python -m pip install --upgrade https://github.com/mne-tools/mne-python/archive/refs/heads/main.zip
              python -m pip install -e .[test,doc]

        - run:
            name: Build the documentation
            no_output_timeout: 30m
            command: |
              make build-doc

        - persist_to_workspace:
            root: doc/_build
            paths: html

        - store_artifacts:
            path: doc/_build/html/
            destination: dev

        # Store the data cache
        - save_cache:
            key: data-cache-0-{{ checksum "./mne_bids/__init__.py" }}
            paths:
              - ~/mne_data

        # Store pip cache
        - save_cache:
            key: pip-cache-0-{{ checksum "./pyproject.toml" }}
            paths:
              - ~/.cache/pip

  docs-deploy:
    # will only be run on main branch
    docker:
      - image: cimg/node:lts
    steps:
      - checkout

      - attach_workspace:
          at: doc/_build

      - run:
          name: Install and configure dependencies
          # do not update gh-pages above 3.0.0
          # see: https://github.com/tschaub/gh-pages/issues/354
          command: |
            npm install gh-pages@3.0.0
            git config --global user.email "circle@mne.com"
            git config --global user.name "Circle Ci"

      - add_ssh_keys:
          fingerprints:
            - "13:a4:d4:26:26:fe:ea:a8:1a:f4:0b:0e:33:67:74:7d"

      - run:
          # push built docs into the `dev` directory on the `gh-pages` branch
          name: Deploy docs to gh-pages branch
          command: node_modules/gh-pages/bin/gh-pages.js --dotfiles --message "doc updates [skip ci]" --dist doc/_build/html --dest ./dev


  link-check:
    machine:
        image: default
    steps:
      - checkout

      - attach_workspace:
          at: doc/_build

      - restore_cache:
          keys:
            - pip-cache-0-{{ checksum "./pyproject.toml" }}

      - run:
          name: Setup Python3 environment
          command: |
              python3 -m venv /home/circleci/mne_bids_env
              echo "source /home/circleci/mne_bids_env/bin/activate" >> $BASH_ENV

      - run:
          name: Install Python packages
          command: |
            python -m pip install --upgrade --progress-bar off pip
            python -m pip install --upgrade https://github.com/mne-tools/mne-python/archive/refs/heads/main.zip
            python -m pip install -e .[test,doc]

      - run:
          name: Check links
          no_output_timeout: 30m
          command: |
            make -C doc linkcheck

workflows:
  commit:
    jobs:
      - docs-build
      - docs-deploy:
          requires:
            - docs-build
          filters:
            branches:
              only: main

  nightly:
    jobs:
      - docs-build

    triggers:
      - schedule:
          cron: "0 4 * * *"
          filters:
            branches:
              only:
                - main

  weekly:
    jobs:
      - docs-build
      - link-check:
          requires:
            - docs-build

    triggers:
      - schedule:
          cron: "0 4 * * 0"
          filters:
            branches:
              only:
                - main