From 6961da20573eedc4036b6eeb7480e282a0fa3de8 Mon Sep 17 00:00:00 2001 From: Shahzeb Siddiqui Date: Wed, 12 Jun 2024 12:39:00 -0400 Subject: [PATCH] add a paragraph in documentation with example using mix of -b, -t and -n for searching buildspecs for validation --- docs/gettingstarted/buildspecs_interface.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/gettingstarted/buildspecs_interface.rst b/docs/gettingstarted/buildspecs_interface.rst index 3a910055b..20148198b 100644 --- a/docs/gettingstarted/buildspecs_interface.rst +++ b/docs/gettingstarted/buildspecs_interface.rst @@ -329,7 +329,7 @@ Validate Buildspecs - ``buildtest buildspec validate`` -------------------------------------------------------- buildtest can validate buildspecs through the ``buildtest buildspec validate`` command which provides -analogous options for ``buildtest build`` for selecting buildspecs such as ``-b``, ``-e``, ``-t`` and ``-e``. +analogous options for ``buildtest build`` for selecting buildspecs such as ``-b``, ``-e``, ``-n``, ``-t`` and ``-x``. This command can be used to validate buildspecs with the JSON Schema which can be useful if you are writing a buildspec and want to validate the buildspec without running the test. @@ -339,7 +339,7 @@ Shown below are the available command options. .. command-output:: buildtest buildspec validate --help -The `-b` option can be used to specify path to buildspec file or directory to validate buildspecs. If its a directory, +The **-b** option can be used to specify path to buildspec file or directory to validate buildspecs. If its a directory, buildtest will traverse all directories recursively and find any **.yml** file extensions and attempt to validate each buildspec. Shown below is an example output of what it may look like @@ -363,6 +363,13 @@ will validate all buildspecs for **python** and **pass** tags. .. command-output:: buildtest buildspec validate -t python -t pass +You can mix and match different options for searching buildspecs to validate. For example, we can +search by buildspec, tags, and name in the following example + +.. dropdown:: ``buildtest buildspec validate -t python -n hello_world -b tutorials/vars.yml`` + + .. command-output:: buildtest buildspec validate -t python -n hello_world -b tutorials/vars.yml + Show buildspec ``buildtest buildspec show`` --------------------------------------------