https://github.com/ddev/ddev-gitpod-launcher

Launch any DDEV project with Gitpod
https://github.com/ddev/ddev-gitpod-launcher

ddev gitpod php

Last synced: about 1 month ago
JSON representation

Launch any DDEV project with Gitpod

• Host: GitHub
• URL: https://github.com/ddev/ddev-gitpod-launcher
• Owner: ddev
• License: apache-2.0
• Created: 2021-11-24T23:48:39.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-04T01:37:21.000Z (2 months ago)
• Last Synced: 2024-07-05T05:06:32.174Z (2 months ago)
• Topics: ddev, gitpod, php
• Language: Shell
• Homepage: https://ddev.github.io/ddev-gitpod-launcher/
• Size: 57.6 KB
• Stars: 12
• Watchers: 7
• Forks: 8
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ddev - ddev-gitpod-launcher

README

        
# 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 `-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](https://github.com/ddev/ddev/tree/master/pkg/ddevapp/dotddev_assets/providers) (see [docs](https://ddev.readthedocs.io/en/latest/users/providers/provider-introduction/)). 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](https://ddev.github.io/ddev-gitpod-launcher/) to launch any website project and edit and develop it in gitpod.

* If the project has a composer.json, the launcher will do a `ddev composer install`

* If the project has a .ddev/config.yaml, it will be respected, otherwise a default will be auto-generated.

## Development

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

### Test a branch of this repo

1. Visit .

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 

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.

* All pre-builds, `init`, and `commands` are run in the new workspace as if were freshly created..

* Debugging output is shown in the original 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.