From cfa5e89ffcf2ee031bae3e233e4b8f635a26385c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Milo=C5=A1=20Prchl=C3=ADk?= Date: Mon, 13 Jan 2025 12:19:22 +0100 Subject: [PATCH] squash: docs --- docs/releases.rst | 3 +++ spec/plans/results.fmf | 11 +++++++---- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/releases.rst b/docs/releases.rst index b051a1f667..16937b712c 100644 --- a/docs/releases.rst +++ b/docs/releases.rst @@ -22,6 +22,9 @@ support for submitting jobs on behalf of a group through the ``beaker-job-group`` key. The submitting user must be a member of the given job group. +The ``note`` field of tmt :ref:`/spec/plans/results` changes from +a string to a list of strings, to better accommodate multiple notes. + tmt-1.40.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/spec/plans/results.fmf b/spec/plans/results.fmf index b58dd7a7e1..c1a4b044eb 100644 --- a/spec/plans/results.fmf +++ b/spec/plans/results.fmf @@ -35,7 +35,7 @@ description: | # List of strings, optional comments to report with the result. note: - - "Things were great." + - Things were great. # List of strings, paths to log files. log: @@ -91,7 +91,7 @@ description: | # List of strings, optional comments to report with the result. note: - - "Things were great." + - Things were great. # List of strings, paths to logs files. log: @@ -130,7 +130,7 @@ description: | # List of strings, optional comments to report with the result. note: - - "Things were great." + - Things were great. # List of strings, paths to log files. log: @@ -259,6 +259,9 @@ description: | .. versionchanged:: 1.37 original result of test, subtest and check is stored in ``original-result`` key. + .. versionchanged:: 1.41 + ``note`` field changed from a string to a list of strings. + __ https://github.com/teemtee/tmt/blob/main/tmt/schemas/results.yaml example: @@ -359,7 +362,7 @@ example: "result": "pass", "log": ["pass_log"], "duration": "00:11:22", - "note": "good result" + "note": ["good result"] } ]