https://github.com/1024pix/renovate-config
Pix shared renovate configuration
https://github.com/1024pix/renovate-config
pix-captains
Last synced: about 2 months ago
JSON representation
Pix shared renovate configuration
- Host: GitHub
- URL: https://github.com/1024pix/renovate-config
- Owner: 1024pix
- License: agpl-3.0
- Created: 2022-12-02T10:00:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-09T00:58:36.000Z (5 months ago)
- Last Synced: 2025-01-16T05:14:17.440Z (3 months ago)
- Topics: pix-captains
- Homepage:
- Size: 1.22 MB
- Stars: 0
- Watchers: 14
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pix Renovate Config
## Why ?
To help developers maintain dependencies up-to-date, we use Renovate with a shared configuration.
Dependencies update can be monitored on the dashboard
https://app.renovatebot.com/dashboard#github/1024pix/renovate-config/
## Available configurations
Here are the available `presets`:
- `default`:
- runs hourly every weekday;
- wait 7 days after a version is published on npm to select it;
- create at most 5 pull request per week;
- approves its own PR using Github App Renovate Approve;
- adds label ":rocket: Ready to Merge" to the PR if update type is a minor or a patch;
- Jean Pierre rebases and merges the PR if required status checks are ok (ex: Actions, CircleCi, Deploy ...).
- `no-auto`:
- runs hourly every weekday;
- wait 7 days after a version is published on npm to select it;
- create at most 5 pull request per week;
- do not merge.
- `auto-patch`:
- runs hourly every weekday;
- wait 7 days after a version is published on npm to select it;
- create at most 5 pull request per week;
- approves its own PR using Github App Renovate Approve;
- adds label ":rocket: Ready to Merge" to the PR if update type is a patch;
- Jean Pierre rebases and merges the PR if required status checks are ok (ex: Actions, CircleCi, Deploy ...).
- `aggressive`:
- runs hourly every weekday;
- wait 7 days after a version is published on npm to select it;
- create as many pull request as necessary;
- approves its own PR using Github App Renovate Approve;
- adds label ":rocket: Ready to Merge" to the PR;
- Jean Pierre rebases and merges the PR if required status checks are ok (ex: Actions, CircleCi, Deploy ...).
`auto-minor` is a deprecated config and should be replaced by the `default` config.
## Project onboarding
Create a `renovate.json` file under `.github` folder.
```json
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["github>1024pix/renovate-config:"],
"enabled": true
}
```
Substitute your preset, eg. `github>1024pix/renovate-config:default`.
Ask a Github organization administrator to activate the application [Renovate][renovate] on the repository.
> Automerge functionnality also requires the application [Renovate Approve][renovate-approve] to be enabled on the repository.
Check the execution logs to make sure it starts for the first time, even if it does not detect any outdated dependency.
Eg. for `pix-bot` repository https://app.renovatebot.com/dashboard#github/1024pix/pix-bot
### Onboarding forked projects
If the project is a fork, you need to add the following configuration in the `renovate.json` file : `"includeForks": true`
Issues are disabled by default on forked projects, Dependency dashboard needs Github Issues to appear.
[renovate]: https://github.com/apps/renovate/installations/new
[renovate-approve]: https://github.com/apps/renovate-approve/installations/new