From 24ecd1ae7e6c3a98162c4ff8f886dc55cde4e32f Mon Sep 17 00:00:00 2001 From: Jean-Paul van Ravensberg <14926452+DevSecNinja@users.noreply.github.com> Date: Tue, 17 Nov 2026 17:49:08 +0100 Subject: [PATCH 1/4] feat(renovate): track shell-script version annotations and CRLF files Add a central custom manager for `# renovate:` annotations above shell assignments (plain versions and image:tag@sha256 values) in .sh, .bash, .zsh, .bats and .tmpl files. It replaces the dccd.sh-only SOPS manager so no line is extracted twice. Accept CRLF after the annotation in the workflow, workflow-image, min_version and Ansible managers. Closes #569 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .mise.toml | 1 + .renovate/customManagers.json5 | 28 +++++-- docs/architecture.md | 10 +++ tests/renovate-shell-manager.sh | 129 ++++++++++++++++++++++++++++++++ 4 files changed, 160 insertions(+), 8 deletions(-) create mode 100644 tests/renovate-shell-manager.sh diff --git a/.mise.toml b/.mise.toml index 33d7aedf..3cbfdb70 100644 --- a/.mise.toml +++ b/.mise.toml @@ -33,6 +33,7 @@ run = [ "bash ./tests/renovate-custom-manager-coverage.sh", "bash ./tests/renovate-apm-manager.sh", "bash ./tests/renovate-annotation-managers.sh", + "bash ./tests/renovate-shell-manager.sh", "bash ./tests/renovate-dprint-plugins.sh", "bash ./tests/renovate-batching-contract.sh", "bash ./tests/renovate-engines-range.sh", diff --git a/.renovate/customManagers.json5 b/.renovate/customManagers.json5 index 4074c5ba..1c4d7a15 100644 --- a/.renovate/customManagers.json5 +++ b/.renovate/customManagers.json5 @@ -2,13 +2,25 @@ $schema: "https://docs.renovatebot.com/renovate-schema.json", customManagers: [ { + // Annotated versions in shell scripts (and chezmoi .tmpl copies), e.g. + // # renovate: datasource=github-releases depName=bats-core/bats-assert + // BATS_ASSERT_VERSION="v2.1.0" + // # renovate: datasource=docker depName=docker.io/library/postgres + // POSTGRES_IMAGE="docker.io/library/postgres:18.3-alpine@sha256:<64 hex>" + // Optional packageName=, versioning=, extractVersion= and registryUrl= + // follow depName= in that order, like Renovate's own *Versions presets. + // An image value keeps its `/:` prefix; only the tag and + // digest are tracked. A value that is not a plain literal (`"${X}"`, + // `"v1.2-$SUFFIX"`) is not matched. Replaces the truenas-apps-only SOPS + // manager for scripts/dccd.sh, which this covers. customType: "regex", - description: "Process SOPS version in dccd.sh", - managerFilePatterns: ["/scripts/dccd\\.sh$/"], + description: "Process annotated versions in shell scripts", + managerFilePatterns: ["/\\.(?:sh|bash|zsh|bats)(?:\\.tmpl)?$/"], matchStrings: [ - "# renovate: datasource=github-releases depName=(?\\S+)\\nSOPS_VERSION=\"(?[^\"]+)\"", + "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=[\"']?(?:[^\\s\"'@$]*/[^\\s\"'@$/]*:|[^\\s\"'@$:/]+:)?(?[A-Za-z0-9][^\\s\"'@$:]*)(?:@(?sha256:[a-f0-9]{64}))?[\"']?(?:[ \\t;#]|\\r?\\n|$)", ], - datasourceTemplate: "github-releases", + datasourceTemplate: "{{{datasource}}}", + versioningTemplate: "{{#if versioning}}{{{versioning}}}{{/if}}", }, { customType: "regex", @@ -18,7 +30,7 @@ "/workflow-templates/.+\\.ya?ml$/", ], matchStrings: [ - "# renovate: datasource=(?\\S+)(?: depName=(?\\S+))?\\n\\s+[\\w-]*version: \\[?\"?(?[^\\s\"\\[\\],]+)\"?\\]?[ \\t]*(?:#[^\\n]*)?(?:\\r?\\n|$)", + "# renovate: datasource=(?\\S+)(?: depName=(?\\S+))?\\r?\\n\\s+[\\w-]*version: \\[?\"?(?[^\\s\"\\[\\],]+)\"?\\]?[ \\t]*(?:#[^\\n]*)?(?:\\r?\\n|$)", ], datasourceTemplate: "{{{datasource}}}", // `depName=` may be omitted for the runtime datasources, e.g. @@ -44,7 +56,7 @@ "/workflow-templates/.+\\.ya?ml$/", ], matchStrings: [ - "# renovate: datasource=(?\\S+) depName=(?\\S+)\\n\\s+[\\w-]+:\\s*\"?[^\\s\"@]+:(?[^\\s\"@]+)@(?sha256:[a-f0-9]+)\"?", + "# renovate: datasource=(?\\S+) depName=(?\\S+)\\r?\\n\\s+[\\w-]+:\\s*\"?[^\\s\"@]+:(?[^\\s\"@]+)@(?sha256:[a-f0-9]+)\"?", ], datasourceTemplate: "{{{datasource}}}", }, @@ -53,7 +65,7 @@ description: "Process min_version in .mise.toml", managerFilePatterns: ["/\\.mise\\.toml$/"], matchStrings: [ - "# renovate: datasource=github-releases depName=(?\\S+)\\nmin_version = \"(?[^\"]+)\"", + "# renovate: datasource=github-releases depName=(?\\S+)\\r?\\nmin_version = \"(?[^\"]+)\"", ], datasourceTemplate: "github-releases", }, @@ -64,7 +76,7 @@ "/ansible/inventory/.+\\.ya?ml$/", ], matchStrings: [ - "# renovate: datasource=(?\\S+) depName=(?\\S+)(?: registryUrl=(?\\S+))?[ \\t]*\\n\\s*[\\w-]+:\\s*\"?(?[^\\s\"]+)\"?", + "# renovate: datasource=(?\\S+) depName=(?\\S+)(?: registryUrl=(?\\S+))?[ \\t]*\\r?\\n\\s*[\\w-]+:\\s*\"?(?[^\\s\"]+)\"?", ], // Any datasource, with an optional registryUrl, and any key on the next // line: the annotation marks the value. For example, Debian packages diff --git a/docs/architecture.md b/docs/architecture.md index 1266f6f5..64f2b55a 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1233,6 +1233,16 @@ can still assign Code Owners if an automerge PR cannot merge cleanly. - **Ansible inventory** (`ansible/inventory/`): any datasource, an optional `registryUrl=` and any key, e.g. Debian packages pinned per suite with `# renovate: datasource=deb depName=docker-ce registryUrl=https://…`. +- **Shell scripts** (`.sh`, `.bash`, `.zsh`, `.bats`, and their chezmoi + `.tmpl` copies): the next line is a `NAME=value` assignment, optionally after + `export`, `local`, `readonly` or `declare`. The annotation can add + `packageName=`, `versioning=`, `extractVersion=` and `registryUrl=`, in that + order. For an image value (`"docker.io/library/postgres:18.3-alpine@sha256:…"`) + only the tag and digest are tracked. Values that aren't plain literals + (`"${OTHER}"`) are skipped. Scripts without one of those extensions are not + scanned. + +All annotation managers accept CRLF line endings as well as LF. ### dprint plugins diff --git a/tests/renovate-shell-manager.sh b/tests/renovate-shell-manager.sh new file mode 100644 index 00000000..f0652c01 --- /dev/null +++ b/tests/renovate-shell-manager.sh @@ -0,0 +1,129 @@ +#!/usr/bin/env bash +# +# Checks the Renovate custom manager for `# renovate:` annotations in shell +# scripts (.renovate/customManagers.json5, "Process annotated versions in shell +# scripts"): +# +# - plain versions, images with a digest, optional annotation fields and +# assignment keywords are extracted; non-literal values are not; +# - CRLF files match like LF files, for every annotation manager; +# - no annotated line is extracted by two managers, which would make Renovate +# update the same value twice (the old dccd.sh SOPS manager is replaced). + +set -euo pipefail + +repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" +custom_managers="${repo_root}/.renovate/customManagers.json5" + +if ! command -v pyjson5 >/dev/null 2>&1; then + echo "error: 'pyjson5' not found on PATH. Run via 'mise run test'." >&2 + exit 1 +fi + +MANAGERS="$(pyjson5 --as-json "${custom_managers}" | tr -d '\r')" python3 - <<'PY' +import json +import os +import re +import sys + +managers = json.loads(os.environ["MANAGERS"])["customManagers"] +errors = [] + + +def compile_js(pattern): + # Renovate uses JavaScript named groups; Python spells them (?P...). + return re.compile(pattern.replace("(?<", "(?P<")) + + +shell = [m for m in managers if m["description"] == "Process annotated versions in shell scripts"] +if len(shell) != 1: + print("error: expected one shell annotation manager", file=sys.stderr) + sys.exit(1) +shell = shell[0] +if any(m["description"].startswith("Process SOPS version") for m in managers): + errors.append("the dccd.sh SOPS manager duplicates the shell manager; remove it") +for m in managers: + for p in m.get("matchStrings", []): + # Renovate runs custom-manager regexes on RE2, which has no lookaround. + if re.search(r"\(\? Date: Tue, 17 Nov 2026 17:59:15 +0100 Subject: [PATCH 2/4] fix(renovate): match only whole literal values in shell annotations Split the shell pattern into exclusive double-quoted, single-quoted and unquoted forms. Each must end at its closing quote or a command separator, so `"1.2.3 ${X}"` is skipped and `V=1.2.3;` captures 1.2.3, not `1.2.3;`. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .renovate/customManagers.json5 | 10 +++++++--- tests/renovate-shell-manager.sh | 23 +++++++++++++++++++---- 2 files changed, 26 insertions(+), 7 deletions(-) diff --git a/.renovate/customManagers.json5 b/.renovate/customManagers.json5 index 1c4d7a15..f071c8df 100644 --- a/.renovate/customManagers.json5 +++ b/.renovate/customManagers.json5 @@ -10,14 +10,18 @@ // Optional packageName=, versioning=, extractVersion= and registryUrl= // follow depName= in that order, like Renovate's own *Versions presets. // An image value keeps its `/:` prefix; only the tag and - // digest are tracked. A value that is not a plain literal (`"${X}"`, - // `"v1.2-$SUFFIX"`) is not matched. Replaces the truenas-apps-only SOPS + // digest are tracked. Three exclusive patterns: double-quoted, single-quoted + // and unquoted values; each must end at the quote or a command separator, + // so a value that is not a plain literal (`"1.2.3 ${X}"`, `1.2.3$S`) + // is not matched. Replaces the truenas-apps-only SOPS // manager for scripts/dccd.sh, which this covers. customType: "regex", description: "Process annotated versions in shell scripts", managerFilePatterns: ["/\\.(?:sh|bash|zsh|bats)(?:\\.tmpl)?$/"], matchStrings: [ - "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=[\"']?(?:[^\\s\"'@$]*/[^\\s\"'@$/]*:|[^\\s\"'@$:/]+:)?(?[A-Za-z0-9][^\\s\"'@$:]*)(?:@(?sha256:[a-f0-9]{64}))?[\"']?(?:[ \\t;#]|\\r?\\n|$)", + "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=\"(?:[^\\s\"'@$;]*/[^\\s\"'@$;/]*:|[^\\s\"'@$;:/]+:)?(?[A-Za-z0-9][^\\s\"'@$;:]*)(?:@(?sha256:[a-f0-9]{64}))?\"(?:[ \\t;#&|]|\\r?\\n|$)", + "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*='(?:[^\\s\"'@$;]*/[^\\s\"'@$;/]*:|[^\\s\"'@$;:/]+:)?(?[A-Za-z0-9][^\\s\"'@$;:]*)(?:@(?sha256:[a-f0-9]{64}))?'(?:[ \\t;#&|]|\\r?\\n|$)", + "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=(?:[^\\s\"'@$;&|<>()#]*/[^\\s\"'@$;&|<>()#/]*:|[^\\s\"'@$;&|<>()#:/]+:)?(?[A-Za-z0-9][^\\s\"'@$;&|<>()#:]*)(?:@(?sha256:[a-f0-9]{64}))?(?:[ \\t;#&|]|\\r?\\n|$)", ], datasourceTemplate: "{{{datasource}}}", versioningTemplate: "{{#if versioning}}{{{versioning}}}{{/if}}", diff --git a/tests/renovate-shell-manager.sh b/tests/renovate-shell-manager.sh index f0652c01..79332504 100644 --- a/tests/renovate-shell-manager.sh +++ b/tests/renovate-shell-manager.sh @@ -48,7 +48,7 @@ for m in managers: if re.search(r"\(\? 1: + errors.append(f"shell manager ({label}): {text!r} matched by {len(matches)} patterns") + got = None if not matches else tuple(matches[0].groupdict().get(n) for n in names) if got != want: errors.append(f"shell manager ({label}): {text!r}: want {want}, got {got}") -m = pattern.search(f"# renovate: datasource=docker depName=app packageName=ghcr.io/o/app versioning=loose registryUrl=https://ghcr.io\nAPP=1.2\n") + +def search(text): + return next((m for m in (p.search(text) for p in patterns) if m), None) + + +m = search(f"# renovate: datasource=docker depName=app packageName=ghcr.io/o/app versioning=loose registryUrl=https://ghcr.io\nAPP=1.2\n") if not m or (m["packageName"], m["versioning"], m["registryUrl"]) != ("ghcr.io/o/app", "loose", "https://ghcr.io"): errors.append(f"shell manager: optional annotation fields not captured: {m and m.groupdict()}") From a5ef8e2defe645fbb23c8d9a3796c4fca256b91c Mon Sep 17 00:00:00 2001 From: Jean-Paul van Ravensberg <14926452+DevSecNinja@users.noreply.github.com> Date: Tue, 17 Nov 2026 18:10:14 +0100 Subject: [PATCH 3/4] fix(renovate): skip backtick values and keep Debian epochs in shell manager Require a registry or namespace path before stripping an image prefix so a leading numeric epoch (5:29.6.2-1~...) stays in the value, and reject backtick command substitutions in double-quoted and unquoted values. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .renovate/customManagers.json5 | 21 ++++++++++++--------- docs/architecture.md | 6 ++++-- tests/renovate-shell-manager.sh | 13 +++++++++++-- 3 files changed, 27 insertions(+), 13 deletions(-) diff --git a/.renovate/customManagers.json5 b/.renovate/customManagers.json5 index f071c8df..e26b44be 100644 --- a/.renovate/customManagers.json5 +++ b/.renovate/customManagers.json5 @@ -9,19 +9,22 @@ // POSTGRES_IMAGE="docker.io/library/postgres:18.3-alpine@sha256:<64 hex>" // Optional packageName=, versioning=, extractVersion= and registryUrl= // follow depName= in that order, like Renovate's own *Versions presets. - // An image value keeps its `/:` prefix; only the tag and - // digest are tracked. Three exclusive patterns: double-quoted, single-quoted - // and unquoted values; each must end at the quote or a command separator, - // so a value that is not a plain literal (`"1.2.3 ${X}"`, `1.2.3$S`) - // is not matched. Replaces the truenas-apps-only SOPS - // manager for scripts/dccd.sh, which this covers. + // An image value keeps its `[:port]//:` prefix; only + // the tag and digest are tracked, so images need a path + // (`docker.io/library/redis:7.4`, not `redis:7.4`). Without a path a value + // keeps a leading numeric Debian epoch (`5:29.6.2-1~…`). Three exclusive + // patterns: double-quoted, single-quoted and unquoted values; each must end + // at the quote or a command separator, so a value that is not a plain + // literal (`"1.2.3 ${X}"`, `1.2.3$S`, a backtick substitution) is not + // matched. Replaces the truenas-apps-only SOPS manager for scripts/dccd.sh, + // which this covers. customType: "regex", description: "Process annotated versions in shell scripts", managerFilePatterns: ["/\\.(?:sh|bash|zsh|bats)(?:\\.tmpl)?$/"], matchStrings: [ - "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=\"(?:[^\\s\"'@$;]*/[^\\s\"'@$;/]*:|[^\\s\"'@$;:/]+:)?(?[A-Za-z0-9][^\\s\"'@$;:]*)(?:@(?sha256:[a-f0-9]{64}))?\"(?:[ \\t;#&|]|\\r?\\n|$)", - "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*='(?:[^\\s\"'@$;]*/[^\\s\"'@$;/]*:|[^\\s\"'@$;:/]+:)?(?[A-Za-z0-9][^\\s\"'@$;:]*)(?:@(?sha256:[a-f0-9]{64}))?'(?:[ \\t;#&|]|\\r?\\n|$)", - "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=(?:[^\\s\"'@$;&|<>()#]*/[^\\s\"'@$;&|<>()#/]*:|[^\\s\"'@$;&|<>()#:/]+:)?(?[A-Za-z0-9][^\\s\"'@$;&|<>()#:]*)(?:@(?sha256:[a-f0-9]{64}))?(?:[ \\t;#&|]|\\r?\\n|$)", + "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=\"(?:[^\\s\"'@$;`]*/[^\\s\"'@$;`/]*:)?(?(?:[0-9]+:)?[A-Za-z0-9][^\\s\"'@$;`:/]*)(?:@(?sha256:[a-f0-9]{64}))?\"(?:[ \\t;#&|]|\\r?\\n|$)", + "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*='(?:[^\\s\"'@$;]*/[^\\s\"'@$;/]*:)?(?(?:[0-9]+:)?[A-Za-z0-9][^\\s\"'@$;:/]*)(?:@(?sha256:[a-f0-9]{64}))?'(?:[ \\t;#&|]|\\r?\\n|$)", + "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=(?:[^\\s\"'@$;`&|<>()#]*/[^\\s\"'@$;`&|<>()#/]*:)?(?(?:[0-9]+:)?[A-Za-z0-9][^\\s\"'@$;`&|<>()#:/]*)(?:@(?sha256:[a-f0-9]{64}))?(?:[ \\t;#&|]|\\r?\\n|$)", ], datasourceTemplate: "{{{datasource}}}", versioningTemplate: "{{#if versioning}}{{{versioning}}}{{/if}}", diff --git a/docs/architecture.md b/docs/architecture.md index 64f2b55a..76824690 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1238,8 +1238,10 @@ can still assign Code Owners if an automerge PR cannot merge cleanly. `export`, `local`, `readonly` or `declare`. The annotation can add `packageName=`, `versioning=`, `extractVersion=` and `registryUrl=`, in that order. For an image value (`"docker.io/library/postgres:18.3-alpine@sha256:…"`) - only the tag and digest are tracked. Values that aren't plain literals - (`"${OTHER}"`) are skipped. Scripts without one of those extensions are not + only the tag and digest are tracked; the image needs a registry or namespace + path, so write `docker.io/library/redis:7.4` rather than `redis:7.4`. Other + values keep a leading Debian epoch (`5:29.6.2-1~…`). Values that aren't plain + literals (`"${OTHER}"`, backtick substitutions) are skipped. Scripts without one of those extensions are not scanned. All annotation managers accept CRLF line endings as well as LF. diff --git a/tests/renovate-shell-manager.sh b/tests/renovate-shell-manager.sh index 79332504..80c7c67d 100644 --- a/tests/renovate-shell-manager.sh +++ b/tests/renovate-shell-manager.sh @@ -68,8 +68,13 @@ cases = { f"{gr}a/b\n local A_VERSION='1.2.3'\n": ("github-releases", "a/b", "1.2.3", None), f'{gr}a/b\nreadonly A_VERSION="1.2.3";\n': ("github-releases", "a/b", "1.2.3", None), f'{gr}a/b\ndeclare -r A_VERSION="1.2.3"': ("github-releases", "a/b", "1.2.3", None), - # Image without a registry path, and a registry with a port - "# renovate: datasource=docker depName=redis\nREDIS_IMAGE=redis:7.4\n": ("docker", "redis", "7.4", None), + # Debian epochs are kept, in every quoting form + f'# renovate: datasource=deb depName=docker-ce\nDOCKER_CE="5:29.6.2-1~debian.13~trixie"\n': ("deb", "docker-ce", "5:29.6.2-1~debian.13~trixie", None), + "# renovate: datasource=deb depName=docker-ce\nDOCKER_CE='5:29.6.2-1~debian.13~trixie'\n": ("deb", "docker-ce", "5:29.6.2-1~debian.13~trixie", None), + "# renovate: datasource=deb depName=docker-ce\nDOCKER_CE=5:29.6.2-1~debian.13~trixie\n": ("deb", "docker-ce", "5:29.6.2-1~debian.13~trixie", None), + # An image needs a path; a registry with a port works + "# renovate: datasource=docker depName=redis\nREDIS_IMAGE=redis:7.4\n": None, + "# renovate: datasource=docker depName=docker.io/library/redis\nREDIS_IMAGE=docker.io/library/redis:7.4\n": ("docker", "docker.io/library/redis", "7.4", None), f'# renovate: datasource=docker depName=registry.local:5000/team/app\nAPP="registry.local:5000/team/app:2.0.1@{digest}"\n': ("docker", "registry.local:5000/team/app", "2.0.1", digest), # Unquoted values end at a command separator @@ -78,6 +83,10 @@ cases = { # Not plain literals, or not annotated: never matched f'{gr}a/b\nA_VERSION="1.2.3 ${{SUFFIX}}"\n': None, f'{gr}a/b\nA_VERSION="1.2.3"$SUFFIX\n': None, + # Command substitution is not a literal + f'# renovate: datasource=docker depName=registry.example/app\nAPP="registry.example/`get_image`:1.2.3"\n': None, + f'# renovate: datasource=docker depName=registry.example/app\nAPP=registry.example/`get_image`:1.2.3\n': None, + f'{gr}a/b\nA_VERSION="`cat VERSION`"\n': None, f'{gr}a/b\nA_VERSION=1.2.3$SUFFIX\n': None, f"{gr}a/b\nA_VERSION='1.2.3\"\n": None, f'{gr}a/b\nA_VERSION="${{OTHER_VERSION}}"\n': None, From a66837933a8723a7f36122e357564b44f06960fc Mon Sep 17 00:00:00 2001 From: Jean-Paul van Ravensberg <14926452+DevSecNinja@users.noreply.github.com> Date: Tue, 17 Nov 2026 20:21:32 +0100 Subject: [PATCH 4/4] fix(renovate): do not end shell values at an adjacent # Bash only starts a comment with # at the beginning of a word, so A_VERSION="1.2.3"#${X} is one word with a substitution. A trailing comment still matches through its preceding whitespace. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> --- .renovate/customManagers.json5 | 6 +++--- tests/renovate-shell-manager.sh | 5 +++++ 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/.renovate/customManagers.json5 b/.renovate/customManagers.json5 index e26b44be..4ffcf566 100644 --- a/.renovate/customManagers.json5 +++ b/.renovate/customManagers.json5 @@ -22,9 +22,9 @@ description: "Process annotated versions in shell scripts", managerFilePatterns: ["/\\.(?:sh|bash|zsh|bats)(?:\\.tmpl)?$/"], matchStrings: [ - "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=\"(?:[^\\s\"'@$;`]*/[^\\s\"'@$;`/]*:)?(?(?:[0-9]+:)?[A-Za-z0-9][^\\s\"'@$;`:/]*)(?:@(?sha256:[a-f0-9]{64}))?\"(?:[ \\t;#&|]|\\r?\\n|$)", - "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*='(?:[^\\s\"'@$;]*/[^\\s\"'@$;/]*:)?(?(?:[0-9]+:)?[A-Za-z0-9][^\\s\"'@$;:/]*)(?:@(?sha256:[a-f0-9]{64}))?'(?:[ \\t;#&|]|\\r?\\n|$)", - "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=(?:[^\\s\"'@$;`&|<>()#]*/[^\\s\"'@$;`&|<>()#/]*:)?(?(?:[0-9]+:)?[A-Za-z0-9][^\\s\"'@$;`&|<>()#:/]*)(?:@(?sha256:[a-f0-9]{64}))?(?:[ \\t;#&|]|\\r?\\n|$)", + "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=\"(?:[^\\s\"'@$;`]*/[^\\s\"'@$;`/]*:)?(?(?:[0-9]+:)?[A-Za-z0-9][^\\s\"'@$;`:/]*)(?:@(?sha256:[a-f0-9]{64}))?\"(?:[ \\t;&|]|\\r?\\n|$)", + "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*='(?:[^\\s\"'@$;]*/[^\\s\"'@$;/]*:)?(?(?:[0-9]+:)?[A-Za-z0-9][^\\s\"'@$;:/]*)(?:@(?sha256:[a-f0-9]{64}))?'(?:[ \\t;&|]|\\r?\\n|$)", + "#[ \\t]*renovate:[ \\t]*datasource=(?\\S+)[ \\t]+depName=(?\\S+)(?:[ \\t]+packageName=(?\\S+))?(?:[ \\t]+versioning=(?\\S+))?(?:[ \\t]+extractVersion=(?\\S+))?(?:[ \\t]+registryUrl=(?\\S+))?[ \\t]*\\r?\\n[ \\t]*(?:(?:export|local|readonly|declare(?:[ \\t]+-[a-zA-Z]+)*)[ \\t]+)?[A-Za-z_][A-Za-z0-9_]*=(?:[^\\s\"'@$;`&|<>()#]*/[^\\s\"'@$;`&|<>()#/]*:)?(?(?:[0-9]+:)?[A-Za-z0-9][^\\s\"'@$;`&|<>()#:/]*)(?:@(?sha256:[a-f0-9]{64}))?(?:[ \\t;&|]|\\r?\\n|$)", ], datasourceTemplate: "{{{datasource}}}", versioningTemplate: "{{#if versioning}}{{{versioning}}}{{/if}}", diff --git a/tests/renovate-shell-manager.sh b/tests/renovate-shell-manager.sh index 80c7c67d..b98edd93 100644 --- a/tests/renovate-shell-manager.sh +++ b/tests/renovate-shell-manager.sh @@ -83,6 +83,11 @@ cases = { # Not plain literals, or not annotated: never matched f'{gr}a/b\nA_VERSION="1.2.3 ${{SUFFIX}}"\n': None, f'{gr}a/b\nA_VERSION="1.2.3"$SUFFIX\n': None, + # A `#` that does not start a word is part of the value, not a comment + f'{gr}a/b\nA_VERSION="1.2.3"#${{SUFFIX}}\n': None, + f"{gr}a/b\nA_VERSION='1.2.3'#${{SUFFIX}}\n": None, + f'{gr}a/b\nA_VERSION=1.2.3#${{SUFFIX}}\n': None, + f'{gr}a/b\nA_VERSION=1.2.3 # pinned\n': ("github-releases", "a/b", "1.2.3", None), # Command substitution is not a literal f'# renovate: datasource=docker depName=registry.example/app\nAPP="registry.example/`get_image`:1.2.3"\n': None, f'# renovate: datasource=docker depName=registry.example/app\nAPP=registry.example/`get_image`:1.2.3\n': None,