From b474730cf602991e0d7b8ca8e346d84e909f33ec Mon Sep 17 00:00:00 2001 From: Yarden Shoham Date: Wed, 12 Oct 2022 19:17:04 +0300 Subject: [PATCH] Refactor Gitpod configuration to improve quick spin up of automated dev environments (#21411) This commit instructs Gitpod to run `docs` in watch mode in fresh development environments so any dev could start hacking in seconds. Also included some vscode extensions for Vue, Go, and Docker. Try it here: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/yardenshoham/gitea/tree/gitpod) Signed-off-by: Yarden Shoham Co-authored-by: Gusted --- .gitpod.yml | 13 +++++++++---- README.md | 6 ++++++ README_ZH.md | 6 ++++++ .../doc/developers/hacking-on-gitea.en-us.md | 6 ++++++ 4 files changed, 27 insertions(+), 4 deletions(-) diff --git a/.gitpod.yml b/.gitpod.yml index eb3114ce0b2..55a12cc9e47 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,5 +1,3 @@ -image: gitpod/workspace-full:latest - tasks: - name: Setup init: | @@ -16,10 +14,13 @@ tasks: command: | gp sync-await setup mkdir -p custom/conf/ - echo -e "[server]\nROOT_URL=https://3000-$GITPOD_WORKSPACE_ID.${GITPOD_WORKSPACE_CLUSTER_HOST}/" > custom/conf/app.ini - echo -e "\n[database]\nDB_TYPE = sqlite3\nPATH = /workspace/gitea/data/gitea.db" >> custom/conf/app.ini + echo -e "[server]\nROOT_URL=$(gp url 3000)/" > custom/conf/app.ini + echo -e "\n[database]\nDB_TYPE = sqlite3\nPATH = $GITPOD_REPO_ROOT/data/gitea.db" >> custom/conf/app.ini export TAGS="sqlite sqlite_unlock_notify" make watch-backend + - name: Run docs + before: sudo bash -c "$(grep 'https://github.com/gohugoio/hugo/releases/download' Makefile | tr -d '\')" # install hugo + command: cd docs && make clean update && hugo server -D -F --baseUrl $(gp url 1313) --liveReloadPort=443 --appendPort=false --bind=0.0.0.0 vscode: extensions: @@ -28,7 +29,11 @@ vscode: - golang.go - stylelint.vscode-stylelint - DavidAnson.vscode-markdownlint + - johnsoncodehk.volar + - ms-azuretools.vscode-docker ports: - name: Gitea port: 3000 + - name: Docs + port: 1313 diff --git a/README.md b/README.md index 80f1159aea1..115cafb58d4 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,12 @@ + + Contribute with Gitpod + diff --git a/README_ZH.md b/README_ZH.md index 2be35742672..0e58ad6d4a4 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -33,6 +33,12 @@ + + Contribute with Gitpod + diff --git a/docs/content/doc/developers/hacking-on-gitea.en-us.md b/docs/content/doc/developers/hacking-on-gitea.en-us.md index 5f1cdff51d5..d8427b58f32 100644 --- a/docs/content/doc/developers/hacking-on-gitea.en-us.md +++ b/docs/content/doc/developers/hacking-on-gitea.en-us.md @@ -19,6 +19,12 @@ menu: {{< toc >}} +## Quickstart + +To get a quick working development environment you could use Gitpod. + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/go-gitea/gitea) + ## Installing go You should [install go](https://golang.org/doc/install) and set up your go