From 97ad7530f14376d85919102e85f3bcc970468b34 Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Wed, 21 Jun 2017 11:45:55 -0400 Subject: [PATCH] Add an appendix to the README Explain the minimum ShellCheck version that is required if ShellCheck is being used by a ci-management project to lint their JJB directory. Change-Id: I5b08f6d29fee189b9cbc7714f2dc0ba646c5e917 Signed-off-by: Thanh Ha --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index cbaaa29d..63cdff37 100644 --- a/README.md +++ b/README.md @@ -196,3 +196,13 @@ in the same structure as configured in the archives directory. In this method a job can define a globstar for example ``**/*.log`` which then causes the archive script to do a globstar search for that pattern and archives any files it finds matching. + +## Appendix + +### ShellCheck + +If ShellCheck is being used to lint global-jjb or any projects that include +global-jjb as part of their project (common with ci-management repos) then +a minimum version of ShellCheck 0.4.x is required as the shell scripts in +this repo uses annotations that were introduced in 0.4.. + -- 2.16.6