add basic docs
All checks were successful
ci/woodpecker/push/lint/3 Pipeline was successful
ci/woodpecker/push/lint/2 Pipeline was successful
ci/woodpecker/push/lint/1 Pipeline was successful
ci/woodpecker/push/renovate Pipeline was successful

This commit is contained in:
OCram85 2024-02-14 14:31:34 +01:00
parent 0e94cfaefb
commit 8d54150f88
3 changed files with 20 additions and 7 deletions

View File

@ -1,3 +1,4 @@
autodiscover autodiscover
automerge automerge
Gitea
tbd tbd

View File

@ -6,26 +6,38 @@
<p align="center"> <p align="center">
<a href="https://gitea.ocram85.com/renovate-bot/config/"> <a href="https://gitea.ocram85.com/renovate-bot/config/">
<img <img
src="/renovate-bot/config/raw/branch/master/assets/social-logo.png" src="./assets/social-logo.png"
alt="config" alt="config"
> >
</a> </a>
</p> </p>
<h1 align="center"> <h1 align="center">
config Local Renovate-Bot Config
</h1> </h1>
<p align="center"> <p align="center">
Renovate-bot instance and preset config
</p> </p>
<p align="center"> <p align="center">
<a href="https://drone.ocram85.com/renovate-bot/config"> <a href="https://ci.ocram85.com/renovate-bot/config">
<img src="https://drone.ocram85.com/api/badges/renovate-bot/config/status.svg" alt="Master Branch Build Status"> <img src="https://ci.ocram85.com/api/badges/renovate-bot/config/status.svg" alt="Main Branch Build Status">
</a> </a>
</p> </p>
## :book: General ## 📖 General
> :bulb: tbd... This repository contains the definition for local the local renovate-bot instance.
Dependency updates will be checked weekly and executed as woodpecker cron job.
| Config file | Description |
| -------------------------------: | ------------------------------------------------------------------------------- |
| [`config.js`](config.js) | Platform relevant config for local instance. |
| [`default.json`](default.json) | Local preset for repos hosted by this Gitea instance. |
| [`renovate.json`](renovate.json) | Basic onboarding which can be copied. Also enables renovate on this repository. |
### Repository Onboarding
1. First check if your Gitea account or organization is listed in the `autodiscoverFilter`.
2. Copy the [`renovate.json`](renovate.json) file for basic onboarding. Modify the file based on your project needs.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 5.5 KiB