From e82f6c6bfca76dbed0cc3e98df7dbcd2b7429105 Mon Sep 17 00:00:00 2001 From: Martin Etmajer Date: Thu, 6 Feb 2025 08:43:46 +0100 Subject: [PATCH 1/6] Make content in column Test Case No. wrappable (#152) * Make content in column Test Case No. wrap --- CHANGELOG.md | 1 + templates/DIL.html.tmpl | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 089a095..ec15dd8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # Changelog ## Unreleased +- Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152)) - Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) - Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152)) diff --git a/templates/DIL.html.tmpl b/templates/DIL.html.tmpl index 6caab57..4e73aed 100644 --- a/templates/DIL.html.tmpl +++ b/templates/DIL.html.tmpl @@ -82,7 +82,7 @@ - + @@ -94,7 +94,7 @@ {{#each data.integrationTests}} - + @@ -122,7 +122,7 @@
Discrepancy IDTest Case No.Test Case No. Level of Test Case Description of Failure or Discrepancy Remediation Action
{{discrepancyID}}{{testcaseID}}{{testcaseID}} Integration {{{description}}} {{{remediation}}}
- + @@ -134,7 +134,7 @@ {{#each data.acceptanceTests}} - + From 8b47b4acd388cb884beaf958f9a4f19a52acf5e8 Mon Sep 17 00:00:00 2001 From: Hector Rodriguez Cornejo Date: Thu, 6 Feb 2025 16:03:45 +0100 Subject: [PATCH 2/6] Remove Jira issue ID strikethrough on SLC documents (#153) * Added custom style to to avoid strikethrough --- CHANGELOG.md | 1 + css/styles.css | 3 +++ 2 files changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ec15dd8..93887d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # Changelog ## Unreleased +- Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) - Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152)) - Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) diff --git a/css/styles.css b/css/styles.css index 84a0897..9ad4f8d 100644 --- a/css/styles.css +++ b/css/styles.css @@ -47,6 +47,9 @@ h5 span { margin-right: 1.5em; } +del { + text-decoration: none; +} input + label { margin-left: 0.5em; From 0c23c7b011e551a96168cf76f9e42519d98bfa99 Mon Sep 17 00:00:00 2001 From: anteloro-boeh <180194797+anteloro-boeh@users.noreply.github.com> Date: Fri, 21 Mar 2025 09:04:09 +0100 Subject: [PATCH 3/6] Squash merge from feature/tir-rm-dyn-data-add-helm-status (#154) --- CHANGELOG.md | 1 + css/styles.css | 21 + scripts/scripts.js | 48 ++- templates/TIR.html.tmpl | 919 ++++++++++++++++++++++++++-------------- 4 files changed, 646 insertions(+), 343 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 93887d3..123b659 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## Unreleased - Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) - Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152)) +- TIR changes: Wording changes to be more inclusive of helm deployments, removed dynamic values from report tables and change in table formatting ([#146](https://github.com/opendevstack/ods-document-generation-templates/pull/146)) - Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) - Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152)) diff --git a/css/styles.css b/css/styles.css index 9ad4f8d..e783b7c 100644 --- a/css/styles.css +++ b/css/styles.css @@ -171,6 +171,27 @@ td.content-wrappable table th, td.content-wrappable table td { white-space: normal; } +/* Remove all spacing around .inner-ul-2 elements */ + +td > ul.inner-ul { + list-style-type: none; + padding: 0em; + margin: 0em; +} + +li > ul.inner-ul { + list-style-type: none; + padding-left: 1em; + padding-right: 0em; + padding-top: 0em; + padding-bottom: 0em; +} + +.inner-span { + display: inline-block; + margin-right: 0em; +} + .center { text-align: center; } diff --git a/scripts/scripts.js b/scripts/scripts.js index 386c5fc..a9a37ab 100644 --- a/scripts/scripts.js +++ b/scripts/scripts.js @@ -1,21 +1,39 @@ function subst() { - var vars = {}; + var vars = {}; - var query_strings_from_url = document.location.search.substring(1).split('&'); - for (var query_string in query_strings_from_url) { - if (query_strings_from_url.hasOwnProperty(query_string)) { - var temp_var = query_strings_from_url[query_string].split('=', 2); - vars[temp_var[0]] = decodeURI(temp_var[1]); + var query_strings_from_url = document.location.search + .substring(1) + .split("&"); + for (var query_string in query_strings_from_url) { + if (query_strings_from_url.hasOwnProperty(query_string)) { + var temp_var = query_strings_from_url[query_string].split("=", 2); + vars[temp_var[0]] = decodeURI(temp_var[1]); + } } - } - var css_selector_classes = ['page', 'frompage', 'topage', 'webpage', 'section', 'subsection', 'date', 'isodate', 'time', 'title', 'doctitle', 'sitepage', 'sitepages']; - for (var css_class in css_selector_classes) { - if (css_selector_classes.hasOwnProperty(css_class)) { - var element = document.getElementsByClassName(css_selector_classes[css_class]); - for (var j = 0; j < element.length; ++j) { - element[j].textContent = vars[css_selector_classes[css_class]]; - } + var css_selector_classes = [ + "page", + "frompage", + "topage", + "webpage", + "section", + "subsection", + "date", + "isodate", + "time", + "title", + "doctitle", + "sitepage", + "sitepages", + ]; + for (var css_class in css_selector_classes) { + if (css_selector_classes.hasOwnProperty(css_class)) { + var element = document.getElementsByClassName( + css_selector_classes[css_class] + ); + for (var j = 0; j < element.length; ++j) { + element[j].textContent = vars[css_selector_classes[css_class]]; + } + } } - } } diff --git a/templates/TIR.html.tmpl b/templates/TIR.html.tmpl index 36a2756..50e39c0 100644 --- a/templates/TIR.html.tmpl +++ b/templates/TIR.html.tmpl @@ -1,384 +1,647 @@ + + Technical Installation Report for '{{ metadata.name }}' + + + +
+
Discrepancy IDTest Case No.Test Case No. Level of Test Case Description of Failure or Discrepancy Remediation Action
{{discrepancyID}}{{testcaseID}}{{testcaseID}} Acceptance {{{description}}} {{{remediation}}}
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Information
+ Name: + + {{ metadata.name }} +
+ Description: + + {{ metadata.description }} +
+ Version: + + {{ metadata.version }}/{{ data.documentHistoryLatestVersionId }} +
Date Created: + {{ metadata.date_created }} +
Git Commit: + {{ metadata.git.commit }} +
Git Tag: + {{ metadata.git.targetTag }} +
Git URL: + {{ metadata.git.url }} +
OpenShift Cluster API URL: + {{ metadata.openShift.apiUrl }} +
+ Created by Jenkins Job Name: + + {{ metadata.jenkins.jobName }} +
+ Created by Jenkins Build Number: + + {{ metadata.jenkins.buildNumber }} +
Target environment: + {{ metadata.buildParameter.targetEnvironment }} +
+
- - Technical Installation Report for '{{metadata.name}}' - - - - -
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- Information -
Name:{{metadata.name}}
Description:{{metadata.description}}
Version:{{metadata.version}}/{{data.documentHistoryLatestVersionId}}
Date Created:{{metadata.date_created}}
Git Commit:{{metadata.git.commit}}
Git Tag:{{metadata.git.targetTag}}
Git URL:{{metadata.git.url}}
OpenShift Cluster API URL:{{metadata.openShift.apiUrl}}
Created by Jenkins Job Name:{{metadata.jenkins.jobName}}
Created by Jenkins Build Number:{{metadata.jenkins.buildNumber}}
Target environment:{{metadata.buildParameter.targetEnvironment}}
-
- -
 
- -

Technical Installation Report for '{{metadata.name}}'

- -

Table of Contents

-
    -
  1. Introduction
    2. -
  2. Installation
    3. -
  3. Diagnostics and Testing
    4. -
  4. Conclusion Statement
    5. -
  5. Definitions and Abbreviations -
      -
    1. Definitions
      2. -
    2. Abbreviations
      3. -
    -
    6. -
  6. Reference Documents
    7. -
  7. Document History
    8. -
-
- -
-

1Introduction

- -

This document describes the installation of the software-defined component {{data.repo.id}}. The installation is based on the corresponding Technical Installation Plan (TIP) of Config Item: {{metadata.buildParameter.configItem}}.

+
 
-

The plan outlines additional chapters, namely Installation Prerequisites (3) and Environmental Conditions (4).

+

Technical Installation Report for '{{ metadata.name }}'

-

Installation plan reference: ITEMS Document Number {{metadata.version}}-{{metadata.jenkins.buildNumber}}, Version: {{metadata.referencedDocs.TIP}}.

+

Table of Contents

+
    +
  1. Introduction
    2. +
  2. Installation
    3. +
  3. Diagnostics and Testing
    4. +
  4. Conclusion Statement
    5. +
  5. + Definitions and Abbreviations +
      +
    1. Definitions
      2. +
    2. Abbreviations
      3. +
    +
    6. +
  6. Reference Documents
    7. +
  7. Document History
    8. +
+
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameters
ParameterValue
Git Commit Component {{id}}{{data.repo.data.git.commit}}
Git Repo Component {{id}}{{data.repo.data.git.url}}
ODS Component Type {{id}}{{data.repo.type}}
Environment{{metadata.buildParameter.targetEnvironment}}
Change Description{{metadata.buildParameter.changeDescription}}
Version{{metadata.buildParameter.version}}
Config Item{{metadata.buildParameter.configItem}}
- +
+

1Introduction

-
-

2Installation

-

Installations steps have been successfully conducted. Overall installation status:

+

+ This document describes the installation of the software-defined + component {{ data.repo.id }}. The installation is based on the corresponding Technical + Installation Plan (TIP) of Config Item: + {{ metadata.buildParameter.configItem }}. +

- - - - - -
StatusOK
+

+ The plan outlines additional chapters, namely + Installation Prerequisites (3) and + Environmental Conditions (4). +

-

2.1Jenkins

-

Jenkins Job has been successfully executed:

+

+ Installation plan reference: ITEMS Document Number + {{ metadata.version }}-{{ metadata.jenkins.buildNumber }}, Version: {{ metadata.referencedDocs.TIP }}. +

- - - - - - +

Parameters

+
NameValue
+ + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + - - + + +
Parameters
ParameterValue
+ Git Commit Component {{ id }} + + {{ data.repo.data.git.commit }} +
+ Git Repo Component {{ id }} + + {{ data.repo.data.git.url }} +
+ ODS Component Type {{ id }} + {{ data.repo.type }}
Environment + {{ metadata.buildParameter.targetEnvironment }} +
Change Description + {{ metadata.buildParameter.changeDescription }} +
Job Number{{metadata.jenkins.buildNumber}}Version + {{ metadata.buildParameter.version }} +
Job Name{{metadata.jenkins.jobName}}Config Item + {{ metadata.buildParameter.configItem }} +
+
+ +
+

2Installation

+

+ Installations steps have been successfully conducted. Overall + installation status: +

+ + - - + + - -
Build URL{{metadata.jenkins.buildUrl}}StatusOK
+ -

2.2Components

-

Note: {{deployNote}}

+

2.1Jenkins

+

Jenkins Job has been successfully executed:

- {{#data.repo}} -

The following components have been successfully installed:{{id}}

- {{#openShiftData}} - - {{#builds}} - -
- {{#each .}} +
+ + + + + + + + + + + + + + +
Job Number + {{ metadata.jenkins.buildNumber }} +
Job Name + {{ metadata.jenkins.jobName }} +
Build URL + {{ metadata.jenkins.buildUrl }} +
+ +

2.2Component

+

Note: {{ deployNote }}

+ + {{#data.repo}} +

+ The following component has been successfully installed: + {{ id }} +

+ {{/data.repo}} + + {{#openShiftData}} + {{#builds}} - Build Resource: {{@key}} -
- - - - - +
NameValue
{{#each .}} - - - + + Build Resource: + {{@key}} +
{{@key}}{{.}}
+ + {{#each .}} + + + + + {{/each}} + +
{{@key}}{{.}}
+ {{/each}} - - + + + {{/builds}} + {{/openShiftData}} + + {{^legacy}} + {{#deploymentMean}} + + + + Deployment +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Namespace + {{ namespace }} +
Managed by + {{ type }} +
+ Source repository + + + {{../data/repo/url}} +
+ Descriptor path + + {{ descriptorPath }} +
+ Environment configuration files + + {{{envConfigFiles}}} +
+ Global configuration files + + {{{configFiles}}} +
+ Configuration parameters + + {{{configParams}}} +
+ Default command line flags + + {{{defaultCmdLineArgs}}} +
+ Additional command line flags + + {{{additionalCmdLineArgs}}} +
+ + {{#deploymentStatus}} + + Deployment Result + + + + + + + + + + + + + + + + + + + +
Status + {{ deployStatus }} +
+ Result message + + {{ resultMessage }} +
Timestamp + {{ lastDeployed }} +
Resources + {{{resources}}} +
+ + {{/deploymentStatus}} + + + {{/deploymentMean}} + {{/legacy}} + + {{#legacy}} + {{#deploymentMean}} + + + + Deployment +
+ + + + + + {{#each .}} + + + + + {{/each}} + +
NameValue
{{@key}} + {{ this }} +
+ + - {{/each}} - - - {{/builds}} - {{#deployments}} - - - {{#each .}} + {{/deploymentMean}} + {{#openShiftData}} + {{#deployments}} - Deployment Resource: {{@key}} -
- - - - - +
NameValue
{{#each .}} - - - + + Deployment Resource: + {{@key}} +
{{@key}}{{this}}
+ + + + + + {{#each .}} + + + + + {{/each}} + +
NameValue
{{@key}} + {{ this }} +
+ {{/each}} - - + - {{/each}} - - - {{/deployments}} - - {{/openShiftData}} - {{/data.repo}} -
- -
-

3Diagnostics and Testing

-

Diagnostic steps have been successfully applied to the requested component.

- -

Diagnostic Status

- - - - - -
StatusOK
+ {{/deployments}} + {{/openShiftData}} + {{/legacy}} + +
-

Diagnostic Result

+
+

3Diagnostics and Testing

+

+ Diagnostic steps have been successfully applied to the requested + component. +

- {{#data.repo}} -

Component {{id}}

- - - - - - - - - +

Diagnostic Status

+
StepInstruction for TestingExpected ResultActual ResultPass / Fail
- - - - - + + - - - - - - - - -
1automated configuration appplication (Q/P environment)Configuration appliedConfiguration appliedpassStatusOK
2POD is runningPOD is in status runningPOD is in status runningpass
- {{/data.repo }} -
+ -
-

4Conclusion Statement

-

All deliverables of the Technical Installation Plan have been successfully executed and the signature of this Report verifies that the system has been installed according to all requirements stated in the Installation Plan or, in the event the requirements are not met, that the deviations and/or failures are properly documented and addressed.

-
+

Diagnostic Result

-
-

5Definitions and Abbreviations

+ {{#data.repo}} +

Component {{ id }}

+ + + + + + + + + + + + + + + + + + + + + + + + +
StepInstruction for TestingExpected ResultActual ResultPass / Fail
1 + Automated configuration appplication (Q/P + environment) + Configuration appliedConfiguration appliedPass
2 + Wait until all Pods, PVCs, Services, and minimum + number of Pods of a Deployment, StatefulSet, or + ReplicaSet are in a ready state + + Applicable resources are in ready state + + Applicable resources are in ready state + Pass
+ {{/data.repo}} +
-

5.1Definitions

- {{#if data.sections.sec5s1.show}} +
+

4Conclusion Statement

+

+ All deliverables of the Technical Installation Plan have been + successfully executed and the signature of this Report verifies + that the system has been installed according to all requirements + stated in the Installation Plan or, in the event the + requirements are not met, that the deviations and/or failures + are properly documented and addressed. +

+
+ +
+

5Definitions and Abbreviations

+ +

5.1Definitions

+ {{#if data.sections.sec5s1.show}} - +
{{{data.sections.sec5s1.content}}} + {{{data.sections.sec5s1.content}}} +
- {{else}} + {{else}}

N/A

- {{/if}} + {{/if}} -

5.2Abbreviations

- {{#if data.sections.sec5s2.show}} +

5.2Abbreviations

+ {{#if data.sections.sec5s2.show}} - +
{{{data.sections.sec5s2.content}}} + {{{data.sections.sec5s2.content}}} +
- {{else}} + {{else}}

N/A

- {{/if}} -
+ {{/if}} +
-
-

6Reference Documents

- - {{#if data.sections.sec6.show}} +
+

6Reference Documents

+
    +
  • + Technical Installation Plan ({{metadata.referencedDocs.TIP}}) +
    • +
+ {{#if data.sections.sec6.show}} - +
{{{data.sections.sec6.content}}} + {{{data.sections.sec6.content}}} +
- {{/if}} -
+ {{/if}} +
-
-

7Document History

- {{#if data.documentHistory}} - - - - - - - - - {{#each data.documentHistory}} - - - - + + {{/each}} + +
VersionDateAuthorChange Reference
{{{docVersion}}}See Summary of electronic document or signature page of printout. - {{{rational}}} -
- {{#each issueType}} - {{#if added}} - The following {{type}} were added: -
    - {{#each added}} -
  • {{key}}{{#if details}}: {{details}}{{/if}}
    • +
    +

    7Document History

    + {{#if data.documentHistory}} + + + + + + + + + {{#each data.documentHistory}} + + + + - - {{/each}} - -
    VersionDateAuthorChange Reference
    {{{docVersion}}} + See Summary of electronic document or signature page + of printout. + + {{{rational}}} +
    + {{#each issueType}} + {{#if added}} + The following {{ type }} were added: +
      + {{#each added}} +
    • + {{ key }}{{#if details}}: {{ details }}{{/if}} +
      • + {{/each}} +
    + {{/if}} + {{#if discontinued}} + The following {{ type }} were removed: +
      + {{#each discontinued}} +
    • + {{ key }}{{#if details}}: {{ details }}{{/if}} +
      • + {{/each}} +
    + {{/if}} + {{#if changed}} + The following {{ type }} were changed: +
      + {{#each changed}} +
    • + {{ key }} was previously {{ predecessors }}{{#if details}}: {{ details }}{{/if}} +
      • + {{/each}} +
    + {{/if}} +
    {{/each}} - - {{/if}} - {{#if discontinued}} - The following {{type}} were removed: -
      - {{#each discontinued}} -
    • {{key}}{{#if details}}: {{details}}{{/if}}
      • - {{/each}} -
    - {{/if}} - {{#if changed}} - The following {{type}} were changed: -
      - {{#each changed}} -
    • {{key}} was previously {{predecessors}}{{#if details}}: {{details}}{{/if}}
      • - {{/each}} -
    - {{/if}} -
    - {{/each}} -
    - {{/if}} - {{#if data.sections.sec7.show}} +
+ {{/if}} + {{#if data.sections.sec7.show}} - +
{{{data.sections.sec7.content}}} + {{{data.sections.sec7.content}}} +
- {{/if}} -
- + {{/if}} + + From 5526e575d5981965027a84c260e6a0e5018a5c85 Mon Sep 17 00:00:00 2001 From: brais <26645694+BraisVQ@users.noreply.github.com> Date: Thu, 10 Apr 2025 13:07:08 +0200 Subject: [PATCH 4/6] Update CHANGELOG for release 1.2.11 --- CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 123b659..ea41579 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,11 @@ # Changelog ## Unreleased + +## 1.2.11 - 2025-4-10 - Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) - Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152)) -- TIR changes: Wording changes to be more inclusive of helm deployments, removed dynamic values from report tables and change in table formatting ([#146](https://github.com/opendevstack/ods-document-generation-templates/pull/146)) +- TIR changes: Wording changes to be more inclusive of helm deployments, removed dynamic values from report tables and change in table formatting ([#146](https://github.com/opendevstack/ods-document-generation-templates/pull/146)) & ([#154](https://github.com/opendevstack/ods-document-generation-templates/pull/154)) - Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) - Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152)) From 936d12e5d2a8d3cdc0989ac41b5f8cd94fc513a2 Mon Sep 17 00:00:00 2001 From: Hector Rodriguez Cornejo Date: Tue, 29 Apr 2025 11:21:20 +0200 Subject: [PATCH 5/6] Fixed html parser errors (#158) --- CHANGELOG.md | 7 +------ templates/CSD-3.html.tmpl | 1 + templates/CSD-5.html.tmpl | 1 + templates/DIL.html.tmpl | 2 +- templates/IVP.html.tmpl | 6 +++--- templates/RA.html.tmpl | 2 +- templates/SSDS-1.html.tmpl | 2 +- templates/SSDS-3.html.tmpl | 2 +- templates/SSDS-4.html.tmpl | 2 +- templates/SSDS-5.html.tmpl | 2 +- templates/TIR-infra.html.tmpl | 2 +- 11 files changed, 13 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ea41579..b4650e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,7 @@ # Changelog ## Unreleased - -## 1.2.11 - 2025-4-10 -- Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) -- Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152)) -- TIR changes: Wording changes to be more inclusive of helm deployments, removed dynamic values from report tables and change in table formatting ([#146](https://github.com/opendevstack/ods-document-generation-templates/pull/146)) & ([#154](https://github.com/opendevstack/ods-document-generation-templates/pull/154)) - +- Fixed html parser errors. ([#158](https://github.com/opendevstack/ods-document-generation-templates/pull/158)) - Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) - Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152)) - TIR changes: Wording changes to be more inclusive of helm deployments, removed dynamic values from report tables and change in table formatting ([#146](https://github.com/opendevstack/ods-document-generation-templates/pull/146)) & ([#154](https://github.com/opendevstack/ods-document-generation-templates/pull/154)) diff --git a/templates/CSD-3.html.tmpl b/templates/CSD-3.html.tmpl index fcb7fd0..8a600b6 100644 --- a/templates/CSD-3.html.tmpl +++ b/templates/CSD-3.html.tmpl @@ -742,6 +742,7 @@ URS Summary: {{{ursName}}}{{#if ursDescription}}
{{{ursDescription}}}{{/if}} {{applicability}} + FS Summary: {{{fsName}}}{{#if fsDescription}}
{{{fsDescription}}}{{/if}} diff --git a/templates/CSD-5.html.tmpl b/templates/CSD-5.html.tmpl index ee2c7dc..2a4a4b2 100644 --- a/templates/CSD-5.html.tmpl +++ b/templates/CSD-5.html.tmpl @@ -268,6 +268,7 @@ {{applicability}} {{/each}} + {{/each}} {{else}} diff --git a/templates/DIL.html.tmpl b/templates/DIL.html.tmpl index 4e73aed..b98d1c9 100644 --- a/templates/DIL.html.tmpl +++ b/templates/DIL.html.tmpl @@ -68,7 +68,7 @@

Functional / Requirements Testing Discrepancy Log

This Discrepancy Log is to be used for documentation of any discrepancies (e.g. failed test cases, test case errors, testing execution errors) found during testing. These should include all test cases where the result has been set to failed.

-

Clarification: Discrepancies detected during a test run will be documented in the Discrepancy Log (DIL) version associated with the test run. The DIL will be created during each test run. Any updated version of the DIL showing no discrepancies serves as evidence for the successful correction of the error(s) causing the discrepancies.
+

Clarification: Discrepancies detected during a test run will be documented in the Discrepancy Log (DIL) version associated with the test run. The DIL will be created during each test run. Any updated version of the DIL showing no discrepancies serves as evidence for the successful correction of the error(s) causing the discrepancies.
Furthermore, this discrepancy log only covers discrepancies from tasks automated through OpenDevStack. Any manual tasks done outside of OpenDevStack, which created discrepancies, must be covered in a secondary DIL.

Integration Testing Discrepancy Log

diff --git a/templates/IVP.html.tmpl b/templates/IVP.html.tmpl index 0a6e66d..7f825c1 100644 --- a/templates/IVP.html.tmpl +++ b/templates/IVP.html.tmpl @@ -312,10 +312,10 @@ Other test cases: {{#if steps}}
    - {{#each steps}} + {{#each steps}}
  1. {{step}}
    2. - {{/each}} -

    N/A

    /ol> + {{/each}} +
{{else}} No test steps defined {{/if}} diff --git a/templates/RA.html.tmpl b/templates/RA.html.tmpl index 2a816c5..11a0cb8 100644 --- a/templates/RA.html.tmpl +++ b/templates/RA.html.tmpl @@ -451,7 +451,7 @@ {{key}} {{type}} - {{{name}}}
{{{description}}} + {{{name}}}
{{{description}}} {{referencesRisk}} {{/each}} diff --git a/templates/SSDS-1.html.tmpl b/templates/SSDS-1.html.tmpl index 726128e..a5ae941 100644 --- a/templates/SSDS-1.html.tmpl +++ b/templates/SSDS-1.html.tmpl @@ -147,7 +147,7 @@ {{/if}} {{#if data.sections.sec16s1.bitbucket}}

- A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.
+ A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.

A person who creates a PR gets attributed as its author and nominates at least one reviewer. Once mandatory changes requested by the reviewers have been incorporated by the contributors, reviewers can approve the PR. An approval permits that the approved contribution can be merged from a temporary source branch into a longer living target branch inside the repository.{{#if metadata.gxp}} A single person must not assume the roles of contributor and reviewer on the same PR (no self-approvals).{{/if}}

diff --git a/templates/SSDS-3.html.tmpl b/templates/SSDS-3.html.tmpl index 2e6e3ec..df85cf1 100644 --- a/templates/SSDS-3.html.tmpl +++ b/templates/SSDS-3.html.tmpl @@ -147,7 +147,7 @@ {{/if}} {{#if data.sections.sec16s1.bitbucket}}

- A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.
+ A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.

A person who creates a PR gets attributed as its author and nominates at least one reviewer. Once mandatory changes requested by the reviewers have been incorporated by the contributors, reviewers can approve the PR. An approval permits that the approved contribution can be merged from a temporary source branch into a longer living target branch inside the repository.{{#if metadata.gxp}} A single person must not assume the roles of contributor and reviewer on the same PR (no self-approvals).{{/if}}

diff --git a/templates/SSDS-4.html.tmpl b/templates/SSDS-4.html.tmpl index 6ff7d99..a11fb84 100644 --- a/templates/SSDS-4.html.tmpl +++ b/templates/SSDS-4.html.tmpl @@ -146,7 +146,7 @@ {{/if}} {{#if data.sections.sec16s1.bitbucket}}

- A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.
+ A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.

A person who creates a PR gets attributed as its author and nominates at least one reviewer. Once mandatory changes requested by the reviewers have been incorporated by the contributors, reviewers can approve the PR. An approval permits that the approved contribution can be merged from a temporary source branch into a longer living target branch inside the repository.{{#if metadata.gxp}} A single person must not assume the roles of contributor and reviewer on the same PR (no self-approvals).{{/if}}

diff --git a/templates/SSDS-5.html.tmpl b/templates/SSDS-5.html.tmpl index 756ce2b..2efd122 100644 --- a/templates/SSDS-5.html.tmpl +++ b/templates/SSDS-5.html.tmpl @@ -152,7 +152,7 @@ {{/if}}

- A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.
+ A Bitbucket Pull Request (PR) is where contributors and reviewers meet to discuss and assert the readiness of a contribution to a Bitbucket repository comprising code, tests, configuration, or a combination of these.

A person who creates a PR gets attributed as its author and nominates at least one reviewer. Once mandatory changes requested by the reviewers have been incorporated by the contributors, reviewers can approve the PR. An approval permits that the approved contribution can be merged from a temporary source branch into a longer living target branch inside the repository.{{#if metadata.gxp}} A single person must not assume the roles of contributor and reviewer on the same PR (no self-approvals).{{/if}}

diff --git a/templates/TIR-infra.html.tmpl b/templates/TIR-infra.html.tmpl index dba66c2..9dd190c 100644 --- a/templates/TIR-infra.html.tmpl +++ b/templates/TIR-infra.html.tmpl @@ -290,7 +290,7 @@

6Reference Documents

    -
  • Technical Installation Plan ({{metadata.referencedDocs.TIP}})
    • +
  • Technical Installation Plan ({{metadata.referencedDocs.TIP}})
{{#if data.sections.sec6.show}} From 93ca2e9125bcec36687fba32a17806b461a11c54 Mon Sep 17 00:00:00 2001 From: brais <26645694+BraisVQ@users.noreply.github.com> Date: Tue, 29 Apr 2025 12:37:22 +0200 Subject: [PATCH 6/6] Changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b4650e6..1ae6d0e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ # Changelog ## Unreleased + +## 1.2.12 - 2025-4-29 - Fixed html parser errors. ([#158](https://github.com/opendevstack/ods-document-generation-templates/pull/158)) - Remove Jira issue ID strikethrough on SLC documents. ([#153](https://github.com/opendevstack/ods-document-generation-templates/pull/153)) - Make content in column Test Case No. wrappable. ([#152](https://github.com/opendevstack/ods-document-generation-templates/pull/152))