From fb7635950ce628d9bd7b828ddaf7e6599728e814 Mon Sep 17 00:00:00 2001 From: Daan Selen Date: Tue, 16 Sep 2025 01:12:44 +0000 Subject: [PATCH] feat(docs): add the instructions on how to use the chart (#60) Fix: https://gitea.com/gitea/helm-actions/issues/59 Co-authored-by: Lunny Xiao Reviewed-on: https://gitea.com/gitea/helm-actions/pulls/60 Reviewed-by: ChristopherHX Reviewed-by: Lunny Xiao Co-authored-by: Daan Selen Co-committed-by: Daan Selen --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index a61a6db..cfce7d3 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,29 @@ If `.Values.image.rootless: true`, then the following will occur. In case you us - If `.Values.provisioning.enabled: true`, then uses the rootless Gitea image, must match helm-Gitea. +## Quick-start + +To get started, add the Helm repo, assuming you have not already: + +```sh +helm repo add gitea-charts https://dl.gitea.com/charts/ +helm repo update +``` + +Then pull the values.yaml file and fill it accordingly. + +```sh +helm show values gitea-charts/actions > values.yaml +``` + +Deploy with your values, make sure the path is correct: + +```sh +helm upgrade --install gitea-actions gitea-charts/actions -f values.yaml +``` + +You should be good to go! + ## Parameters ### Gitea Actions