From eb0ff6954edecb4b88c3d3f032050314dc984dd0 Mon Sep 17 00:00:00 2001 From: James hong Date: Tue, 2 Jul 2024 19:37:40 +1000 Subject: [PATCH] doc update and tiltfile update 1. add bit more docs 2. tilt file update to prevent start up if .secret is missing. --- Tiltfile | 5 +++++ docs/contributing.md | 8 ++++++++ 2 files changed, 13 insertions(+) diff --git a/Tiltfile b/Tiltfile index e5ea9cba..90161660 100644 --- a/Tiltfile +++ b/Tiltfile @@ -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') diff --git a/docs/contributing.md b/docs/contributing.md index 8e113f9c..841fb610 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -72,6 +72,14 @@ To get started do the following: ```console 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: