From e661e24e5f6fde1da096a177fe52296c7a6c7c19 Mon Sep 17 00:00:00 2001 From: Kevin James <KevinJames@thekev.in> Date: Thu, 22 Aug 2019 20:44:51 -0700 Subject: [PATCH] docs(regex): fixup regex docs (#4347) --- lib/versioning/regex/index.ts | 2 +- website/docs/configuration-options.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/versioning/regex/index.ts b/lib/versioning/regex/index.ts index 5fb6da5e65..d85d0a163d 100644 --- a/lib/versioning/regex/index.ts +++ b/lib/versioning/regex/index.ts @@ -22,7 +22,7 @@ export class RegExpVersioningApi extends GenericVersioningApi<RegExpVersion> { // RegExp('^(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)(-(?<prerelease>.*))?$') // * emulates the "docker" configuration: // RegExp('^(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)(-(?<compatibility>.*))?$') - // * matches the versoining scheme used by the Python images on DockerHub: + // * matches the versioning scheme used by the Python images on DockerHub: // RegExp('^(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)(?<prerelease>[^.-]+)?(-(?<compatibility>.*))?$'); private _config: RegExp = null; diff --git a/website/docs/configuration-options.md b/website/docs/configuration-options.md index 4ce863b32a..3e2d16bdf2 100644 --- a/website/docs/configuration-options.md +++ b/website/docs/configuration-options.md @@ -1175,7 +1175,7 @@ For the `regex` `versionScheme`, will accept a regex string after a colon, for e ```json { - "versionScheme": "regex:^(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)(?<prerelease>[^.-]+)?(-(?<architecture>.*))?$" + "versionScheme": "regex:^(?<major>\\d+)\\.(?<minor>\\d+)\\.(?<patch>\\d+)(?<prerelease>[^.-]+)?(-(?<compatibility>.*))?$" } ``` @@ -1183,7 +1183,7 @@ The valid capture groups for the `regex` `versionScheme` are: - `major`, `minor`, and `patch`: at least one of these must be provided. When determining whether a package has updated, these values will be compared in the standard semantic versioning fashion. If any of these fields are omitted, they will be treated as if they were `0` -- in this way, you can describe versioning schemes with up to three incrementing values. - `prerelease`: this value, if captured, will mark a given release as a prerelease (eg. unstable). If this value is captured and you have set `"ignoreUnstable": true`, the given release will be skipped. -- `architecture`: this value defines the "build architecture" of a given dependency. A proposed Renovate update will never change the specified architecture. For example, if you are pinning to `1.2.3-linux` (and `linux` is captured as the architecture), Renovate will not update you to `1.2.4-osx`. +- `compatibility`: this value defines the "build compatibility" of a given dependency. A proposed Renovate update will never change the specified compatibility value. For example, if you are pinning to `1.2.3-linux` (and `linux` is captured as the compatbility value), Renovate will not update you to `1.2.4-osx`. ## vulnerabilityAlerts -- GitLab