From 69e87f129418df8ca0c5c4c8e5a36cc9d7d6cfbe Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 20 Nov 2026 12:54:58 -0500 Subject: [PATCH] docs(deps): standardize the CPM lockfile heading --- package-lock.cmake | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/package-lock.cmake b/package-lock.cmake index badbeb90..cfd16d3d 100644 --- a/package-lock.cmake +++ b/package-lock.cmake @@ -8,17 +8,18 @@ # Renovate-bot will update the versions and hashes in this file when a new version of a dependency is released. # The comments above each dependency are used by renovate to identify the dependencies and extract the version numbers. -# See https://github.com/LizardByte/.github/blob/master/renovate-config.json5 for the configuration of renovate. +# See https://github.com/LizardByte/.github/blob/master/renovate/cmake.json5 for the configuration of renovate. # # Expected dependency structure for new entries: -# - Start each block with a human-readable comment, for example `# Example dependency`. +# - Start each block with the dependency name, for example `# Example dependency`. # - Follow it with consecutive renovate metadata comments. # - The first metadata line must start with `# renovate:` and include `datasource=` and `depName=`. -# - Optional metadata keys are `packageName=`, `versioning=`, `extractVersion=`, and `registryUrl=`. +# - Optional metadata keys are `versioning=`, `extractVersion=`, and `registryUrl=`. # - Optional metadata may stay on the `# renovate:` line or continue on the next consecutive `#` lines. -# - Keep metadata keys in this order: `datasource`, `depName`, `packageName`, `versioning`, -# `extractVersion`, `registryUrl`. +# - Keep metadata keys in this order: `datasource`, `depName`, `versioning`, `extractVersion`, `registryUrl`. # - After metadata, declare the tracked value with `set(NAME_VERSION ...)` or `set(NAME_TAG ...)`. +# - For `git-refs`, add a `# ref=` line and `set(NAME_COMMIT ...)`. Renovate reads the URL from +# the literal `GIT_REPOSITORY` in the following `CPMDeclarePackage(...)`. # - If the dependency also tracks a SHA256, keep `set(NAME_SHA256 ...)` immediately after the # matching `NAME_VERSION` or `NAME_TAG` line with no unrelated lines between them. # - Keep `CPMDeclarePackage(...)` below the tracked values.