Skip to content

Commit

Permalink
fix pre-commit check for CONTRIBUTING.md (#1098)
Browse files Browse the repository at this point in the history
  • Loading branch information
iQQBot committed May 22, 2023
1 parent 0ced2ee commit 0e170c0
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,29 +202,40 @@ The final step to make sure your newly added image gets published is to update t
### Manually testing within a workspace

If you want to manually test with a debug workspace, you can do the following:

1. Open a Gitpod workspace with your Pull Request
1. Using the provided script, build the combo you want to test

```bash
./build-combo.sh full # replace "full" with your combo's name from dazzle.yaml
```

1. Pull the image locally

```bash
docker pull localhost:5000/dazzle:full # again, replace "full" here
```

1. Create a testing directory where you'll test your repo (e.g. `test/`)
1. Create a `.gitpod.yml` and a corresponding `gitpod.Dockerfile`:
```yml
# test/.gitpod.yml
image:
file: gitpod.Dockerfile
```
```Dockerfile
# test/gitpod.Dockerfile
FROM localhost:5000/dazzle:full # replace "full" with your own
FROM localhost:5000/dazzle:full # replace "full" with your own
# ... optionally, more steps here
1. Now you can test using [`gp validate`](https://www.gitpod.io/docs/references/gitpod-cli#validate). This will open a debug workspace where you can try out your changes:
```
1. Now you can test using [`gp validate`](https://www.gitpod.io/docs/references/gitpod-cli#validate).
This will open a debug workspace where you can try out your changes:
```bash
gp validate --workspace-folder="/workspace/workspace-images/test"
```
If you want to change something and re-test, you will want to do steps 1,2 and 6 again.
If you want to change something and re-test, you will want to do steps 1,2 and 6 again.

0 comments on commit 0e170c0

Please sign in to comment.