summary refs log tree commit diff stats
path: root/testament
diff options
context:
space:
mode:
Diffstat (limited to 'testament')
-rw-r--r--testament/important_packages.nim16
1 files changed, 15 insertions, 1 deletions
diff --git a/testament/important_packages.nim b/testament/important_packages.nim
index c9126e1c7..b913f4626 100644
--- a/testament/important_packages.nim
+++ b/testament/important_packages.nim
@@ -1,4 +1,18 @@
-# xxx instead of pkg1, pkg2, use the more flexible `NIM_TESTAMENT_BATCH` (see #14823).
+##[
+## note
+`useHead` should ideally be used as the default but lots of packages (e.g. `chronos`)
+don't have release tags (or have really old ones compared to HEAD), making it
+impossible to test them reliably here.
+
+packages listed here should ideally have regularly updated release tags, so that:
+* we're testing recent versions of the package
+* the version that's tested is stable enough even if HEAD may occasionally break
+]##
+
+
+#[
+xxx instead of pkg1, pkg2, use the more flexible `NIM_TESTAMENT_BATCH` (see #14823).
+]#
 
 template pkg1(name: string; cmd = "nimble test"; url = "", useHead = true): untyped =
   packages1.add((name, cmd, url, useHead))