renovate-config/README.md

44 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

2025-01-29 12:21:33 +01:00
# renovate-config
2025-01-29 11:57:35 +01:00
2025-01-29 12:21:33 +01:00
[![Renovate](https://git.smail.koeln/homelab/renovate-config/badges/workflows/renovate.yaml/badge.svg)](https://git.smail.koeln/homelab/renovate-config)
2025-01-29 12:00:23 +01:00
2025-01-29 11:59:52 +01:00
- [renovate-config](#renovate-config)
2024-05-27 15:43:23 +02:00
- [requirements](#requirements)
2024-05-27 15:47:56 +02:00
- [additions](#additions)
2024-05-27 15:43:23 +02:00
- [acknowledgments](#acknowledgments)
2025-01-29 12:21:33 +01:00
To host the renovate config:
2024-05-21 22:07:11 +00:00
- `config.js` holds the self-hosted Renovate configuration so that Renovate knows what and how it should process.
- `renovate.json` in this repository ensures to receive Renovate updates.
- `default.json` holds the basic config for all repositories. It extends the presets by the renovate project defined in `renovate-schema.json`.
2025-01-29 11:57:35 +01:00
- Each repository can extend/alter this config by adding a `renovate.json` file to the root of their own repository.
2024-05-21 22:16:13 +00:00
2024-05-27 15:43:23 +02:00
## requirements
2024-05-21 22:32:40 +00:00
1. Create a new bot account e.g. renovate-bot.
2024-06-11 10:58:12 +02:00
2. Create a personal access token (*PAT*) for your renovate-bot account with the following scopes:
1. activitypub: no access
2. issue: read and write
3. misc: read
4. notifications: read
5. organization: read
6. package: read (if you use forgejo packages)
7. repository: read and write
8. user: read
2024-05-21 22:32:40 +00:00
3. Create a new organisation e.g. homelab.
4. Add your renovate-bot account as owner to the organization.
5. Add renovate-bot *PAT* as a secret (*RENOVATE_TOKEN*) in the organization.
6. renovate-bot can now manage your repositories in the organization.
2024-05-21 22:16:13 +00:00
2024-05-27 15:47:56 +02:00
### additions
2024-05-27 15:43:23 +02:00
2024-06-11 10:58:12 +02:00
1. Generate your GitHub access token (read only) under Settings / Developer Settings
2. Docker.io login credentials (username and access token)
2024-05-27 15:43:23 +02:00
## acknowledgments
2024-05-21 22:16:13 +00:00
2024-05-21 22:18:52 +00:00
- [renovatebot docs](https://docs.renovatebot.com/modules/platform/gitea/)
2024-05-21 22:16:13 +00:00
- [gitea renovate config](https://gitea.com/gitea/renovate-config)
2024-05-27 15:43:23 +02:00
- [naoalb renovate config](https://code.naoalb.org/naoalb-Infrastructure/renovate-config)
- [augmentedmind.de](https://www.augmentedmind.de/2023/07/30/renovate-bot-introduction/)