important_packages: document that packages tested should ideally have recent release tags (#17134)

This commit is contained in:
Timothee Cour
2021-02-21 19:55:20 -08:00
committed by GitHub
parent 4556901572
commit 04b1120334

View File

@@ -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))