Skip to content

Commit

Permalink
doc update and tiltfile update
Browse files Browse the repository at this point in the history
1. add bit more docs
2. tilt file update to prevent start up if .secret is missing.
  • Loading branch information
Greyeye committed Jul 2, 2024
1 parent 236a646 commit f87538b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
5 changes: 5 additions & 0 deletions Tiltfile
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ load('ext://uibutton', 'cmd_button')
load('ext://helm_resource', 'helm_resource')
load('./.tilt/terraform/Tiltfile', 'local_terraform_resource')
load('./.tilt/utils/Tiltfile', 'check_env_set')

# Check if the .secret file exists
if not os.path.exists('.secret'):
fail('The .secret file is missing. Please copy .secret file from .secret.example and setup before running Tilt.')

dotenv(fn='.secret')

config.define_bool("enable_repo", True, 'create a new project for testing this app')
Expand Down
14 changes: 12 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,23 @@ To get started do the following:

* Copy the `.secret.example` and set required values.

```console
```bash
cd ..
cp .secret.example .secret
```
You will need to fill in either `GITLAB_TOKEN` or `GITLAB_TOKEN`
If you are testing with GITHUB, please set the tile_config.json file to specify the vcs-type as the default is `gitlab`.
The token you specify must have ability to get repositories, add/delete comment and webhooks.
```json
{
"vcs-type": "github"
}
```

* From the root directory of this repo:

```console
```bash
cd ..
tilt up
```

Expand Down

0 comments on commit f87538b

Please sign in to comment.