https://github.com/glotzerlab/renovate-config

Common Renovate configuration for glotzerlab.
https://github.com/glotzerlab/renovate-config

Last synced: 4 months ago
JSON representation

Common Renovate configuration for glotzerlab.

• Host: GitHub
• URL: https://github.com/glotzerlab/renovate-config
• Owner: glotzerlab
• Created: 2025-09-04T17:58:37.000Z (9 months ago)
• Default Branch: trunk
• Last Pushed: 2025-09-04T20:05:06.000Z (9 months ago)
• Last Synced: 2025-09-04T20:33:45.715Z (9 months ago)
• Size: 2.93 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Renovate configuration for glotzerlab

To migrate a package from dependabot to Renovate:

- [ ] Enable auto-merge in settings.

- [ ] Allow squash commits in settings.

- Configure the branch protection rule:

  - [ ] Uncheck "Restrict updates".

  - [ ] Require 1 approval.

  - [ ] Ensure that specific status checks are required.

Then request installation of the *Renovate* and *renovate-approve* apps.

On the PR that it creates:

- [ ] Remove `dependabot.ya?ml`.

- If using any `uv pip compile` files:

  - [ ] Modify the headers to use the syntax `--python-version={version}` (if present).

  - [ ] Modify the header to include `--output-file={output-file-name}.txt`

  - [ ] Remove any use of `--python-platform`.

  - [ ] (recommended) Remove any pinning in the `.in` files. Updates

    to one dependency at a time often fail to resolve (e.g. the latest *nbsphinx*

    does not work with the latest *sphinx*). We could either pin in `.in` files and

    accept many permanently open failing PRs, or unpin in `.in` files and get the

    latest full compatible set of packages weekly. The disadvantage to unpinning

    is that you don't get notification that some dependencies failed to update.

  - [ ] Check the renovate logs for the repository and ensure that pip-compile

    finds the `requirements*.txt` files and does not report any warnings or errors.

    These files should also be listed in the PR description.

  - [ ] Remove the `update-uv-lockfiles` action (if used).

- If using any conda lockfiles (see https://github.com/glotzerlab/fresnel/pull/294 for an example):

  - [ ] Convert the conda `environment.yaml` to `pixi.toml`.

  - [ ] Remove `environment.yaml` and all generated conda lockfiles.

  - [ ] Switch from `setup-micromamba` to `setup-pixi` in the GitHub Actions workflows.

  - [ ] Remove the `update-conda-lockfiles` action (if used).