@@ -185,6 +185,30 @@ If an external required non-trivial changes, even if you were able to make the
185185changes yourself, consider separating that external into its own pull request
186186and assigning it to the associated feature owner.
187187
188+ ## drake-external-examples
189+
190+ The
191+ [ drake_cmake_external] ( https://github.com/RobotLocomotion/drake-external-examples/tree/main/drake_cmake_external )
192+ example demonstrates the use of some of Drake's CMake options for user-provided
193+ external packages as part of the public API. While users may be able to provide their own versions
194+ which don't necessarily match those officially supported by Drake, the official
195+ examples should match and be kept up-to-date as part of the monthly upgrades
196+ process.
197+
198+ The packages are listed in Drake's ` MODULE.bazel ` , and the corresponding
199+ user-provided versions in drake-external-examples are found in the calls to
200+ ` ExternalProject_Add ` in the example's
201+ [ CMakeLists.txt] ( https://github.com/RobotLocomotion/drake-external-examples/blob/main/drake_cmake_external/CMakeLists.txt ) .
202+ Any time these packages are upgraded in Drake (via the steps above, or
203+ separately from the monthly upgrades), then use the
204+ [ automated upgrade script] ( https://github.com/RobotLocomotion/drake-external-examples/blob/main/private/upgrade_cmake_externals.py )
205+ to create a pull request on drake-external-examples with the corresponding
206+ upgrade.
207+
208+ See the script for its usage requirements; in general, the version
209+ used there should match the version in Drake exactly, minus the "bcr..." at the
210+ end of the version string.
211+
188212# Changing the version of third-party software manually
189213
190214The instructions for updating third-party software differ depending on how
0 commit comments