.gitpod.yml

# Rebuilding SciPy on init - rather than on prebuild: this ensures
# that even forks do have a usable freshly built SciPy
# Might delegate this later to prebuild with Q2 improvements on gitpod
# https://www.gitpod.io/docs/config-start-tasks/#configuring-the-terminal
# please note that the conda env *must* be activated again for ccache to
# work, else it fails with a very cryptic message
# -------------------------------------------------------------------------

image: scipy/scipy-gitpod:latest
tasks:
  - name: Prepare development
    init: |
      mkdir -p .vscode
      cp tools/docker_dev/settings.json .vscode/settings.json
      conda activate scipy-dev
      git submodule update --init
      python dev.py build -j2
      echo "🛠 Completed rebuilding SciPy!! 🛠 "
      echo "📖 Building docs 📖 "
      python dev.py doc
      echo "✨ Pre-build complete! You can close this terminal ✨ "
  
# --------------------------------------------------------
# exposing ports for liveserve
ports:
  - port: 5500
    onOpen: notify

# --------------------------------------------------------
# some useful extensions to have
vscode:
  extensions:
    - bungcip.better-toml
    - eamodio.gitlens
    - lextudio.restructuredtext
    - ms-python.python
    - njpwerner.autodocstring
    - ritwickdey.liveserver
    - yzhang.markdown-all-in-one

# --------------------------------------------------------
# using prebuilds for the container - note: atm this only
# works for the SciPy repo
# With this configuration the prebuild will happen on push to main 
github:
  prebuilds:
    # enable for main branch
    main: true
    # enable for other branches (defaults to false) 
    branches: false 
    # enable for pull requests coming from this repo (defaults to true) 
    pullRequests: false
    # enable for pull requests coming from forks (defaults to false)
    pullRequestsFromForks: false
    # add a check to pull requests (defaults to true)
    addCheck: false
    # add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
    addComment: false
    # add a "Review in Gitpod" button to the pull request's description (defaults to false)
    addBadge: false
    # add a label once the prebuild is ready to pull requests (defaults to false)
    addLabel: false