From 8b1c11d9d6d915dc264e58add0b9150f058aaf02 Mon Sep 17 00:00:00 2001 From: Sebastian Mark Date: Sat, 29 Jul 2023 17:57:24 +0200 Subject: [PATCH] doc: merge README.renovate into README --- README.md | 38 ++++++++++++++++++++++++++++++++++++-- README.renovate.md | 33 --------------------------------- 2 files changed, 36 insertions(+), 35 deletions(-) delete mode 100644 README.renovate.md diff --git a/README.md b/README.md index 047b0bf..6dc2a80 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,42 @@ * [ara-server](https://ara.recordsansible.org/) * [c19d](https://gitlab.com/smsvc/c19d/) -* [removate-bot](https://github.com/renovatebot/renovate) (see [README.renovate.md](README.renovate.md)) +* [removate-bot](https://github.com/renovatebot/renovate) (see [Renovate Bot](#renovate-bot)) ## Installation -see [argocd-init.yaml in k8s/baseline](https://git.smsvc.net/k8s/baseline/src/branch/main/argocd-init.yml) +`kubectl apply -f argocd_app.yml` + +### Renovate-Bot + +The deployment only applies the basic settings for renovate, but does not include any credentials or platform configuration. + +Create a new secret to provide the necessary settings: + +``` +--- +apiVersion: v1 +kind: Secret +metadata: + name: renovate-env + namespace: renovate +type: Opaque +stringData: + GITHUB_COM_TOKEN: 'your-github-token-here' + RENOVATE_PLATFORM: 'gitea' + RENOVATE_ENDPOINT: 'https://git.smsvc.net/' + RENOVATE_TOKEN: 'your-api-token-here' + LOG_LEVEL: info +``` + +You must set at least `RENOVATE_PLATFORM`, `RENOVATE_ENDPOINT` and `RENOVATE_TOKEN`. +You can set any configuration that can be set by environment variable (see References). + +--- + +References: + +- [Supported Platforms](https://docs.renovatebot.com/modules/platform/) +- [Self-Hosted configuration](https://docs.renovatebot.com/self-hosted-configuration/) +- [GitHub.com token for release notes](https://docs.renovatebot.com/getting-started/running/#githubcom-token-for-release-notes) +- [Log debug levels](https://docs.renovatebot.com/troubleshooting/#log-debug-levels) diff --git a/README.renovate.md b/README.renovate.md deleted file mode 100644 index 28bd983..0000000 --- a/README.renovate.md +++ /dev/null @@ -1,33 +0,0 @@ -# Renovate Bot - -The baseline only applies the basic settings for renovate, but does not include any credentials or platform configuration. - -Create a new secret to provide the necessary settings: - -``` ---- -apiVersion: v1 -kind: Secret -metadata: - name: renovate-env - namespace: renovate -type: Opaque -stringData: - GITHUB_COM_TOKEN: 'your-github-token-here' - RENOVATE_PLATFORM: 'gitea' - RENOVATE_ENDPOINT: 'https://git.smsvc.net/' - RENOVATE_TOKEN: 'your-api-token-here' - LOG_LEVEL: info -``` - -You must set at least `RENOVATE_PLATFORM`, `RENOVATE_ENDPOINT` and `RENOVATE_TOKEN`. -You can set any configuration that can be set by environment variable (see References). - ---- - -References: - -- [Supported Platforms](https://docs.renovatebot.com/modules/platform/) -- [Self-Hosted configuration](https://docs.renovatebot.com/self-hosted-configuration/) -- [GitHub.com token for release notes](https://docs.renovatebot.com/getting-started/running/#githubcom-token-for-release-notes) -- [Log debug levels](https://docs.renovatebot.com/troubleshooting/#log-debug-levels)