From 04b11203343b76cb854fcba66cf25d5f7bba3683 Mon Sep 17 00:00:00 2001 From: Timothee Cour Date: Sun, 21 Feb 2021 19:55:20 -0800 Subject: [PATCH] important_packages: document that packages tested should ideally have recent release tags (#17134) --- testament/important_packages.nim | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) 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))