mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-31 09:41:46 +00:00
Jamie Tanna
2d239d2cc1
* docs: explicitly document `depTypes` each manager supports A long-standing question we receive is "what `depTypes` can I match against in my project". Although the best recommendation we usually have is "check the `packageFiles with updates" log line (as a very key log line for users), we can go one step further and try and create a stronger contract. To do this, I've used Claude Sonnet 4.6 to work through the codebase, determine areas that a `depType` is set in a manager (statically or dynamically) and generate a structured, typed, means to document how they're used. Through a few iterations of the process, and attempts at human-written documentation, we've settled on: - prioritising autogenerated documentation (for humans to read) to note what `depTypes` are known, and what they are - `knownDepTypes`, to describe any known, static, `depType`s and their human-readable meaning - with the `prettyDepType`, if used - `supportsDynamicDepTypesNote`, to add a Markdown note to the generated documentation While here, we also: - make sure to note this in the "adding a new package manager" documentation - remove any hand-written references to `depTypes` in each manager's documentation page - correct the Gleam `depTypes` - make sure to use the `knownDepTypes`'s `prettyDepType` definition if we know it, for a given `depType` The descriptions have been generated by Claude Sonnet, with some human-written tweaks where appropriate. [0]: https://github.com/renovatebot/renovate/discussions/15176 Co-authored-by: Claude Sonnet 4.6 <jamie.tanna+claude-code@mend.io> * fixup! docs: explicitly document `depTypes` each manager supports * docs(manager): display `depTypes` documentation if none present For consistency, and to make it more explicit. --------- Co-authored-by: Claude Sonnet 4.6 <jamie.tanna+claude-code@mend.io>
36 lines
2.3 KiB
Markdown
36 lines
2.3 KiB
Markdown
Renovate can update `gleam.toml` and/or `manifest.toml` files.
|
|
|
|
### How Renovate updates `gleam.toml` files
|
|
|
|
The `gleam` manager extracts dependencies for the `hex` datasource, and uses Renovate's implementation of Hex SemVer to evaluate `gleam.toml` updates.
|
|
|
|
### How Renovate updates `manifest.toml` files
|
|
|
|
The `gleam` manager uses the `gleam` program to update `manifest.toml` files.
|
|
|
|
### Enable `lockFileMaintenance`
|
|
|
|
We recommend you set [`lockFileMaintenance`](../../../configuration-options.md#lockfilemaintenance) to `true` for the `gleam` manager, in your Renovate config.
|
|
This way Renovate can update all your dependencies, including those with in-range updates.
|
|
|
|
`lockFileMaintenance=true` periodically refreshes your `manifest.toml` files, ensuring all dependencies are updated to their latest allowed versions.
|
|
|
|
### Default `rangeStrategy=auto` behavior
|
|
|
|
Renovate's default [`rangeStrategy`](../../../configuration-options.md#rangestrategy) is `"auto"`.
|
|
Here's how `"auto"` works with the `gleam` manager:
|
|
|
|
| Version type | New version | Old range | New range after update | What Renovate does |
|
|
| :----------------------- | :---------- | :----------------------- | :----------------------- | :------------------------------------------------------------------------ |
|
|
| Complex range | `0.16.0` | `>= 0.14.0 and < 0.15.0` | `>= 0.14.0 and < 0.16.1` | Widen range to include the new version. |
|
|
| Simple range | `0.39.0` | `<= 0.38.0` | `<= 0.39.0` | If update outside current range: widens range to include the new version. |
|
|
| Exact version constraint | `0.13.0` | `== 0.12.0` | `== 0.13.0` | Replace old version with new version. |
|
|
|
|
### Recommended `rangeStrategy` for apps and libraries
|
|
|
|
For applications, we recommend using `rangeStrategy=pin`.
|
|
This pins your dependencies to exact versions, which is generally considered [best practice for apps](../../../dependency-pinning.md).
|
|
|
|
For libraries, use `rangeStrategy=widen` with version ranges in your `gleam.toml`.
|
|
This allows for greater compatibility with other projects that may use your library as a dependency.
|