https://github.com/oxidecomputer/renovate-config
Oxide's shared renovate configuration
https://github.com/oxidecomputer/renovate-config
Last synced: 11 months ago
JSON representation
Oxide's shared renovate configuration
- Host: GitHub
- URL: https://github.com/oxidecomputer/renovate-config
- Owner: oxidecomputer
- License: mpl-2.0
- Created: 2022-01-08T00:38:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-07-14T03:12:13.000Z (12 months ago)
- Last Synced: 2025-07-14T06:03:08.331Z (12 months ago)
- Size: 76.2 KB
- Stars: 6
- Watchers: 20
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# renovate-config
Oxide's self-hosted Renovate runner and shared configuration
## Running Renovate against a new repository
Renovate is available as a Mend hosted service or a self-hosted GitHub action. The [Renovate docs](https://docs.renovatebot.com/getting-started/use-cases/) describe the process of enabling the Mend hosted variant. To enable the Oxide self-hosted version the repository will need to be added to the allow list in `runner/global.json`. Once the change is merged to main, our self-hosted version of Renovate will start running against the repository.
### Quick-Start: Setup for Oxide self-hosted Renovate
Assuming you want an Oxide repository to be managed by our self-hosted renovate, you can perform the following steps:
1. Add the following file as `renovate.json` into your repository
```json
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"local>oxidecomputer/renovate-config"
]
}
```
2. Add your repository name to `runner/global.json` within this repository.
3. Look for an issue called "Dependency Dashboard" which renovate should open within your repository. If this exists, your integration was successful.
### Why use the self-hosted version?
If your repository requires the use of post upgrade scripts, then you will need to use the self-hosted version instead of the Mend hosted version. Our self-hosted version also declares an allow list of expected script locations that are allowed to be run: [global config](runner/global.json). To make this easier you can extend the `post-upgrade` configuration file from this repository in your `renovate.json` configuration file.
## Default configuration
Any presets that you want to enable across all repos with Renovate enabled in Oxide's GitHub organization can be added to `default.json`. Avoid putting any rules directly in default, instead using separate preset files for a cleaner configuration.
## Rust configuration
See [`rust/README.adoc`](rust/README.adoc).
## Running post upgrade scripts
To run post-upgrade scripts:
1. Check in an executable script at the location `tools/renovate-post-upgrade.sh` in your repository.
2. Ensure you're using self-hosted Renovate, and add your repository to the list in the [global config](runner/global.json).
3. In your repository's `renovate.json`, extend from `local>oxidecomputer/renovate-config:post-upgrade`.
## More info
To learn more about how to include these shared config files in your own Renovate setup see Renovate's [preset hosting](https://docs.Renovatebot.com/config-presets/#preset-hosting) documentation.
## Future plans
### Pinning GitHub Actions digests
We may make it a requirement very soon for GitHub Actions digests to be pinned to a hash. To enable
pinning, plus automerging updates to some allowlisted actions (to reduce developer burden), extend
from `local>oxidecomputer/renovate-config//actions/pin` in your `renovate.json`.
If you have access to Oxide RFDs, see [RFD 434](https://rfd.shared.oxide.computer/rfd/0434) for more.
### Automatic merges
We currently do not perform any automatic merges of dependency PRs, but in the near future we might
want to enable automerges for allowlisted crates on an opt-in basis. Instructions to do so will be
added here.