ddev / ddev-gitpod-launcher

Launch any DDEV project with Gitpod
https://ddev.github.io/ddev-gitpod-launcher/
Apache License 2.0
12 stars 8 forks source link
ddev gitpod php

ddev-gitpod-launcher

Launch and develop any web project in gitpod using ddev.

  1. Get the https URL of the repository you want to work with.
  2. (Optional) Provide database and user-generated files dumps in a (probably private) repository named <repo>-artifacts. For example. if you have a repository named https://github.com/ddev/d10simple the private artifacts git repository will be at https://github.com/ddev/d10simple-artifacts.
    • In that repository, check in db.sql.gz and files.tgz and push it. This only needs to be updated when you need to update it.
    • For future use, you may want to implement a ddev pull integration, for example for Acquia or Pantheon or Platform.sh or any other of the example providers (see docs). The git technique is used here because you may not have any other initial way to get database and files into gitpod until you set something up.

Go to DDEV gitpod launcher to launch any website project and edit and develop it in gitpod.

Development

While developing this repo, the following tips may be helpful.

Test a branch of this repo

  1. Visit https://ddev.github.io/ddev-gitpod-launcher/.
  2. Enter target repo.
  3. Copy the "Link used by "Open in Gitpod" button:" URL
  4. Replace https://github.com/ddev/ddev-gitpod-launcher/ with the branch path Eg. https://github.com/tyler36/ddev-gitpod-launcher/tree/wip-branch

Gitpod Validation

This technique involves spawning debug workspaces.

  1. Visit https://ddev.github.io/ddev-gitpod-launcher/
  2. Enter target repo.
  3. Click "open in repo".
  4. Make required changes.
  5. In the terminal, type gp validate.

This will spawn a new Gitpod workspace based on the current workspace.

To end the session, press Ctrl+c, or Command+c, in the original window. This will terminate the debug workspace and while maintaining the original workspace.