Skip to main content

Integrating with Gitpod and Codespaces

On the project pages of the Conveyor UI we can show links to online development environments. We support both Gitpod and GitHub Codespaces. The links will only show up when the git link is filled in and the integration is enabled. When you don't see those links, reach out to your Conveyor account admin.

The Conveyor cookiecutter templates come with pre-configuration for both integrations. When you want to add the Conveyor CLI to an existing configuration, we recommend the following configuration:

.gitpod.yml
# List the start up tasks. Learn more https://www.gitpod.io/docs/config-start-tasks/
tasks:
  - name: Gitpod config (browser open, workspace bin path)
    init: |
      mkdir -p /workspace/bin
      cat > /workspace/bin/open.sh <<'EOF'
      #!/bin/bash
      exec gp preview --external "$@"
      EOF
      chmod +x /workspace/bin/open.sh
    command: |
      sudo update-alternatives --install /usr/bin/www-browser www-browser /workspace/bin/open.sh 100
      exit
  - name: Install conveyor
    init: curl -s https://static.conveyordata.com/cli-install/install.sh | bash
    command: |
      curl -s https://static.conveyordata.com/cli-install/update.sh | bash
      exit