Skip to content

Commit

Permalink
docs(versioning): small style fixes (#26352)
Browse files Browse the repository at this point in the history
  • Loading branch information
HonkingGoose committed Dec 18, 2023
1 parent 3c07925 commit 71d5935
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/usage/modules/versioning.md
Expand Up @@ -6,24 +6,25 @@ title: Versioning

Once Managers have extracted dependencies, and Datasources have located available versions, then Renovate will use a "Versioning" scheme to perform sorting and filtering of results.
The "versioning" is different for each package manager, because different package managers use different versioning schemes.
For example, `npm` uses`1.0.0-beta.1` and `pip` uses `1.0.0b1`.
For example, `npm` uses `1.0.0-beta.1` while `pip` uses `1.0.0b1`.

## Why you might need to manually configure versioning

Renovate interprets versions correctly out-of-the-box most of the time.
It's impossible to automatically detect **all** versioning schemes, so sometimes you need to tell the bot what versioning scheme it should use.
But Renovate can't automatically detect **all** versioning schemes.
So sometimes you need to tell the bot what versioning scheme it should use.

You can manually configure/override the `versioning` value for a particular dependency.
You can manually configure or override the `versioning` value for a particular dependency.
You generally won't need to override the defaults for ecosystems which enforce a strict version scheme like `npm`.

Configuring or overriding the default `versioning` can be particularly helpful for ecosystems like Docker/Kubernetes/Helm, where versioning is barely a "convention".
Configuring or overriding the default `versioning` can be extra helpful for ecosystems like Docker, Kubernetes or Helm, where versioning is barely a "convention".

## General concepts behind overriding versioning

- Although you can reconfigure versioning per-manager or per-datasource, it's unlikely that such a broad change would ever be needed
- Although you can reconfigure versioning per-manager or per-datasource, you probably don't need such a broad change
- More commonly you would need to configure `versioning` for individual packages or potentially package patterns
- The best way to do this is with `packageRules`, with a combination of `matchManagers`, `matchDatasources`, `matchPackageNames` and `matchPackagePatterns`.
Avoid configuring `versioning` in a rule that also uses `matchUpdateTypes`, as the update types aren't known at the time the `versioning` is applied.
Avoid configuring `versioning` in a rule that also uses `matchUpdateTypes`, as the update types aren't known at the time the `versioning` is applied

## Examples of versioning overrides

Expand Down

0 comments on commit 71d5935

Please sign in to comment.