mirror of
https://github.com/renovatebot/renovate.git
synced 2026-10-24 22:48:06 +00:00
docs: use unicode arrow (→) instead of ASCII (->) (#42896)
* chore(docs): use unicode arrow (→) instead of ASCII (->) * more changes
This commit is contained in:
@@ -600,9 +600,9 @@ All messages are prefixed with `bumpVersions` or `bumpVersions(<name>)` to help
|
||||
|
||||
It's possible to bump short versions:
|
||||
|
||||
- `1` -> `2` (major)
|
||||
- `1.1` -> `2.0` (major)
|
||||
- `1.2` -> `1.3` (minor)
|
||||
- `1` → `2` (major)
|
||||
- `1.1` → `2.0` (major)
|
||||
- `1.2` → `1.3` (minor)
|
||||
|
||||
### `bumpVersions.bumpType`
|
||||
|
||||
@@ -2347,7 +2347,7 @@ registry=https://gitlab.myorg.com/api/v4/packages/npm/
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! note
|
||||
Values containing a URL path but missing a scheme will be prepended with 'https://' (e.g. `domain.com/path` -> `https://domain.com/path`)
|
||||
Values containing a URL path but missing a scheme will be prepended with 'https://' (e.g. `domain.com/path` → `https://domain.com/path`)
|
||||
|
||||
### `hostRules.maxRequestsPerSecond`
|
||||
|
||||
@@ -3889,7 +3889,7 @@ For example to replace the npm package `jade` with version `2.0.0` of the packag
|
||||
|
||||
Use the `replacementVersionTemplate` config option to control the replacement version.
|
||||
|
||||
For example, the following package rule can be used to replace version with major-only version (17.0.1 -> 17):
|
||||
For example, the following package rule can be used to replace version with major-only version (17.0.1 → 17):
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -4398,10 +4398,10 @@ You can configure `pruneStaleBranches=false` to disable deleting orphan branches
|
||||
Behavior:
|
||||
|
||||
- `auto` = Renovate decides (this will be done on a manager-by-manager basis)
|
||||
- `pin` = convert ranges to exact versions, e.g. `^1.0.0` -> `1.1.0`
|
||||
- `bump` = e.g. bump the range even if the new version satisfies the existing range, e.g. `^1.0.0` -> `^1.1.0`
|
||||
- `pin` = convert ranges to exact versions, e.g. `^1.0.0` → `1.1.0`
|
||||
- `bump` = e.g. bump the range even if the new version satisfies the existing range, e.g. `^1.0.0` → `^1.1.0`
|
||||
- `replace` = Replace the range with a newer one if the new version falls outside it, and update nothing otherwise
|
||||
- `widen` = Widen the range with newer one, e.g. `^1.0.0` -> `^1.0.0 || ^2.0.0`
|
||||
- `widen` = Widen the range with newer one, e.g. `^1.0.0` → `^1.0.0 || ^2.0.0`
|
||||
- `update-lockfile` = Update the lock file when in-range updates are available, otherwise `replace` for updates out of range. Works for `bundler`, `cargo`, `composer`, `gleam`, `npm`, `yarn`, `pnpm`, `terraform`, `poetry` and `uv` so far
|
||||
- `in-range-only` = Update the lock file when in-range updates are available, ignore package file updates
|
||||
|
||||
|
||||
@@ -80,7 +80,7 @@ So first of all, you can choose to read the changelogs and/or visually inspect t
|
||||
|
||||
If you did not catch the fault before merging, you are still better off with a pinned version.
|
||||
If you discover something wrong in production, you can easily "roll back" commits in your development environment until you find which rollback fixes the problem.
|
||||
Then you can simply revert that commit (reversing `foobar@1.1.0` -> `foobar@1.2.0`) and push that to `main`.
|
||||
Then you can simply revert that commit (reversing `foobar@1.1.0` → `foobar@1.2.0`) and push that to `main`.
|
||||
When the next release of `foobar` comes out (e.g. `1.2.1`) you will be prompted with a new PR and hopefully inspect it carefully this time before merge!
|
||||
|
||||
As you can see in the above, pinning dependencies makes your build more consistent and predictable as a developer.
|
||||
|
||||
@@ -79,7 +79,7 @@ The configuration below overrides Renovate's default `docker` versioning for the
|
||||
In most ecosystems, especially SemVer, major upgrades are treated as breaking changes.
|
||||
But other updates may have breaking changes too, for example:
|
||||
|
||||
- In SemVer, any update from a 0.x version may be breaking (including `0.1.0` -> `0.1.1`, `0.1.0` -> `0.2.0` and `0.1.0` -> `1.0.0`)
|
||||
- In SemVer, any update from a 0.x version may be breaking (including `0.1.0` → `0.1.1`, `0.1.0` → `0.2.0` and `0.1.0` → `1.0.0`)
|
||||
- Updates from pre-release versions like `1.0.0-pre.1` to other versions (including stable versions like `1.0.0`) can be breaking
|
||||
- Python makes breaking changes in minor updates, e.g. from `3.12` to `3.13`
|
||||
|
||||
|
||||
@@ -67,7 +67,7 @@ You can use the Code Generator in the sidebar and copy the regex in the generate
|
||||
<!-- prettier-ignore -->
|
||||
!!! warning "Escape the backslashes from regex101"
|
||||
Before you copy/paste the regex from regex101 into your Renovate config, you must escape the backslashes (`\`) first.
|
||||
For example: `\n\s` --> `\\n\\s`.
|
||||
For example: `\n\s` → `\\n\\s`.
|
||||
|
||||
## Glob matching
|
||||
|
||||
|
||||
+5
-5
@@ -42,11 +42,11 @@ The `replacements.json` file has all the replacement presets.
|
||||
|
||||
When a package gets renamed, you need to tell Renovate:
|
||||
|
||||
- the datasource of the package -> `matchDatasources`
|
||||
- the old package name -> `matchPackageNames`
|
||||
- the new package name -> `replacementName`
|
||||
- the last version available for the old package name -> `matchCurrentVersion`
|
||||
- the first version available for the new package name -> `replacementVersion`
|
||||
- the datasource of the package → `matchDatasources`
|
||||
- the old package name → `matchPackageNames`
|
||||
- the new package name → `replacementName`
|
||||
- the last version available for the old package name → `matchCurrentVersion`
|
||||
- the first version available for the new package name → `replacementVersion`
|
||||
|
||||
You can omit `replacementVersion` if the current version is the same as the new version.
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ The config has:
|
||||
- `sourceUrl`: a HTTP URL pointing to the source code (for example on GitHub)
|
||||
- `homepage`: a HTTP URL for the package's homepage. Ideally should be empty if the homepage and `sourceUrl` are the same
|
||||
- `changelogUrl`: a URL pointing to the package's changelog (could be a Markdown file, for example). If not present then Renovate will search the `sourceUrl` for a changelog file
|
||||
- `tags`: an object mapping tag -> version, for example `tags: { latest: '3.0.0' }`. This is only used by the `followTags` function
|
||||
- `tags`: an object mapping tag → version, for example `tags: { latest: '3.0.0' }`. This is only used by the `followTags` function
|
||||
|
||||
## getDigest
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ This is implemented with two-level cache:
|
||||
|
||||
Either full or delta sync is performed, depending on the cache state.
|
||||
|
||||
All the data of this layer is stored in-memory as the mapping `packageName -> version[]`.
|
||||
All the data of this layer is stored in-memory as the mapping `packageName → version[]`.
|
||||
|
||||
```mermaid
|
||||
stateDiagram-v2
|
||||
|
||||
@@ -93,7 +93,7 @@ something:4.7.2 something-else:4.7.2
|
||||
|
||||
If you're looking for an online regex testing tool that supports capture groups, try [regex101.com](<https://regex101.com/?flavor=javascript&flags=g®ex=ENV%20YARN_VERSION%3D(%3F%3CcurrentValue%3E.*%3F)%5Cn&testString=FROM%20node%3A12%0AENV%20YARN_VERSION%3D1.19.1%0ARUN%20curl%20-o-%20-L%20https%3A%2F%2Fyarnpkg.com%2Finstall.sh%20%7C%20bash%20-s%20--%20--version%20%24%7BYARN_VERSION%7D>).
|
||||
You must select the `ECMAScript (JavaScript)` flavor of regex.
|
||||
Backslashes (`'\'`) of the resulting regex have to still be escaped e.g. `\n\s` --> `\\n\\s`.
|
||||
Backslashes (`'\'`) of the resulting regex have to still be escaped e.g. `\n\s` → `\\n\\s`.
|
||||
You can use the Code Generator in the sidebar and copy the regex in the generated "Alternative syntax" comment into JSON.
|
||||
|
||||
##### Renovate's regex differs from the online tools
|
||||
|
||||
@@ -27,7 +27,7 @@ Those permissions can be granted on a repository level within the permission set
|
||||
## Install Review Plugin
|
||||
|
||||
To let Renovate access the Pull Request API, you must install the Review Plugin with at least version 3.11.0.
|
||||
Find the list of available plugins by going to Administration -> Plugins -> Available.
|
||||
Find the list of available plugins by going to Administration → Plugins → Available.
|
||||
|
||||
## Supported versions of SCM-Manager
|
||||
|
||||
|
||||
Reference in New Issue
Block a user