From f67fd0b8aef5388db10aa7d2b04b6d7b957961c1 Mon Sep 17 00:00:00 2001 From: Sean Parent Date: Thu, 16 Jul 2026 16:10:19 -0700 Subject: [PATCH] Clarify [DEPENDENCY] marker and ci.yml.in header comment Copilot review on stlab-copy-on-write#14 flagged two docs issues that trace back to cpp-library: the [DEPENDENCY] search-marker convention wasn't specified as non-rendering, so a consumer copied it into their README as visible text; and the generated ci.yml header pointed to cmake/cpp-library-ci.cmake without noting the file lives in the cpp-library dependency, not the consumer's own repo. Co-Authored-By: Claude Sonnet 5 --- README.md | 4 +++- templates/.github/workflows/ci.yml.in | 3 ++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 931ee6c..1687a00 100644 --- a/README.md +++ b/README.md @@ -539,7 +539,9 @@ The dependency provider (CMake 3.24+) tracks `find_package()` and `CPMAddPackage ## Development -To update cpp-library dependencies search for `[DEPENDENCY]`. +To update cpp-library dependencies search for `[DEPENDENCY]`. Embed the marker in an HTML +comment (e.g. ``) rather than as visible text, so it doesn't render in +rendered docs. To use a local copy of cpp-library: diff --git a/templates/.github/workflows/ci.yml.in b/templates/.github/workflows/ci.yml.in index 03f0369..e76aba3 100644 --- a/templates/.github/workflows/ci.yml.in +++ b/templates/.github/workflows/ci.yml.in @@ -1,6 +1,7 @@ # Auto-generated from cpp-library (https://github.com/stlab/cpp-library) # Do not edit this file directly - it will be overwritten when templates are regenerated -# Dependency versions are defined in cmake/cpp-library-ci.cmake (with source links) +# Dependency versions are defined in cpp-library's cmake/cpp-library-ci.cmake +# (https://github.com/stlab/cpp-library/blob/main/cmake/cpp-library-ci.cmake), not in this repo name: CI