Prepare release 1.2.8 (#143)

opendevstack · Jun 7, 2024 · 5d1081e · 5d1081e
1 parent b713287
commit 5d1081e
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 36 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+## 1.2.8 - 2024-06-06
+- RA doc in section 4.1 has got a typo in Description of column Requirement ([#142](https://github.com/opendevstack/ods-document-generation-templates/pull/142))
+- Changed the branch name to N/A in the TIP for not included component ([#141](https://github.com/opendevstack/ods-document-generation-templates/pull/141))
+- Added some clarification to TIP and TIR ([#140](https://github.com/opendevstack/ods-document-generation-templates/pull/140))
+- Included the new "Requirements" column and the new description which include all the data that is going to be shown. ([#139](https://github.com/opendevstack/ods-document-generation-templates/pull/139))
+- Included the complete Requirement description to Risk Assessment Table ([#138](https://github.com/opendevstack/ods-document-generation-templates/pull/138))
+- Add support for partial deployment ([#137](https://github.com/opendevstack/ods-document-generation-templates/pull/137))
+
 ## 1.2.7 - 2023-11-20
 - minor non-GxP handling fixes  ([#133](https://github.com/opendevstack/ods-document-generation-templates/pull/133))
 - Align center for first column in table in CSD ([#125](https://github.com/opendevstack/ods-document-generation-templates/issues/125))

diff --git a/templates/IVP.html.tmpl b/templates/IVP.html.tmpl
@@ -109,7 +109,7 @@
                 <tr>
                     <td class="content-wrappable"><em>{{id}}</em></td>
                     <td class="content-wrappable">{{type}}</td>
-                    <td class="content-wrappable">{{doInstall}}</td>
+                    <td class="content-wrappable">{{#if doInstall}} Yes {{else}} No {{/if}}</td>
                 </tr>
                 {{/each}}
             </tbody>

diff --git a/templates/IVR.html.tmpl b/templates/IVR.html.tmpl
@@ -111,14 +111,12 @@
             <thead>
                 <th class="lean">Component Name</th>
                 <th class="lean">Repository Type</th>
-                <th class="lean">Installed by ODS</th>
             </thead>
             <tbody>
                 {{#each data.repositories}}
                 <tr>
                     <td class="content-wrappable"><em>{{id}}</em></td>
                     <td class="content-wrappable">{{type}}</td>
-                    <td class="content-wrappable">{{doInstall}}</td>
                 </tr>
                 {{/each}}
             </tbody>

diff --git a/templates/Overall-TIR-Cover.html.tmpl b/templates/Overall-TIR-Cover.html.tmpl
@@ -85,36 +85,37 @@
 
     <div class="page">
         <h2><span>1</span>Installed Component Summary</h2>
-        <p><pre>Based on the component type, as mentioned in the TIP, the following components were installed, and where applicable:</pre>
+        <p><pre>The following components were installed by ODS, and where applicable, these additional tasks were done:</pre>
             <ul>
                 <li>Tags for promotion were generated (<i>Git Tag Created</i>)</li>
                 <li>Configuration was exported, and stored (<i>Exported Configuration Commit</i>)</li>
             </ul>
         </p>
         <table>
             <thead>
-                <th class="content-wrappable">Component ID</th>
-                <th class="content-wrappable">Type</th>
-                <th class="content-wrappable">Installed by ODS</th>
+                <th class="content-wrappable">Software Module Name/ID</th>
+                <th class="content-wrappable">Component Type</th>
                 <th class="content-wrappable">Branch</th>
                 <th class="content-wrappable">Commit Build/Installed | Exported Configuration Commit</th>
                 <th class="content-wrappable">Git Tag Used (optional)</th>
                 <th class="content-wrappable">Git Tag Created (optional)</th>
             </thead>
 			<tbody>
 				{{#each data.repositories}}
+                {{#if doInstall}}
 				<tr>
 					<td class="content-wrappable">{{id}}</td>
 					<td class="content-wrappable">{{type}}</td>
-					<td class="content-wrappable">{{doInstall}}</td>
 					<td class="content-wrappable">{{data.git.branch}}</td>
 					<td class="content-wrappable">{{data.git.commit}} | {{data.git.createdExecutionCommit}}</td>
 					<td class="content-wrappable">{{data.git.baseTag}}</td>
 					<td class="content-wrappable">{{data.git.targetTag}}</td>
 				</tr>
+                {{/if}}
 				{{/each}}
 			</tbody>
         </table>
+        <p>Please consult the TIP document for a comprehensive overview of all system components.</p>
     </div>
 
     <div class="page">

diff --git a/templates/RA.html.tmpl b/templates/RA.html.tmpl
@@ -148,13 +148,11 @@
 					<td class="content-wrappable">Identifier of the risk for reference within other documents</td>
 				</tr>
 				<tr>
-					<td class="lean">Requirement No.</td>
-					<td class="content-wrappable">Unambiguous reference to a specific requirement, function or a group of requirements in a reference document. The prefix indicates the referenced document</td>
-				</tr>
-				<tr>
-					<td class="lean">Requirement Summary</td>
-					<td class="content-wrappable">Short description of requirement or function</td>
-				</tr>
+                    <td class="lean">Requirements</td>
+                    <td class="content-wrappable">Requirement No: Unambiguous reference to a specific requirement, function or a group of requirements in a reference document.<br/>
+                    Requirement Summary: Short description of requirement or function.<br/>
+                    Requirement Description: Detailed description of requirement or function.</td>
+                </tr>
 				<tr>
 					<td class="lean">GxP</td>
 					<td class="content-wrappable">Relevance of the requirement or function for GxP or non-GxP (e.g. business). See section 4.2.1</td>
@@ -407,8 +405,7 @@
 		<table id="Risk Assessment Table">
             <thead>
                 <th class="content-wrappable">Risk No.</th>
-                <th class="content-wrappable">Requirement No.</th>
-				<th class="content-wrappable">Requirement Summary</th>
+				<th class="content-wrappable">Requirements</th>
 				<th class="content-wrappable">GxP (see <a href="#section_4_2_1">4.2.1</a>)</th>
 				<th class="content-wrappable">Description of risks/failures (or reason for GxP = No)</th>
 				<th class="content-wrappable">Prob. Occur.</th>
@@ -423,10 +420,11 @@
 				{{#each data.sections.sec5.risks }}
 				<tr>
 					<td class="lean">{{key}}</td>
-					<td class="lean">{{{requirementsKey}}}</td>
-					<td class="content-wrappable">{{{requirements}}}</td>
+				    <td class="content-wrappable">
+                    {{requirement.key}}: {{requirement.name}}.<br/>{{{requirement.description}}}
+                    </td>
 					<td class="lean">{{gxpRelevance}}</td>
-					<td class="content-wrappable">Summary:{{name}}.<br>{{{description}}}</td>
+					<td class="content-wrappable">Summary: {{name}}.<br/>{{{description}}}</td>
 					<td class="content-wrappable">{{probabilityOfOccurrence}}</td>
 					<td class="content-wrappable">{{severityOfImpact}}</td>
 					<td class="content-wrappable">{{probabilityOfDetection}}</td>

diff --git a/templates/SSDS-1.html.tmpl b/templates/SSDS-1.html.tmpl
@@ -262,7 +262,6 @@
 					<th>Version</th>
 					<th class="content-wrappable">Description of Functionality</th>
 					<th>References</th>
-					<th class="content-wrappable">Installed by ODS</th>
 				</thead>
                 <tbody>
 					{{#each data.sections.sec5s1.components}}
@@ -273,7 +272,6 @@
 						<td class="content-wrappable">{{version}}</td>
 						<td class="content-wrappable">{{description}}</td>
 						<td class="content-wrappable">{{references}}</td>
-						<td class="content-wrappable">{{doInstall}}</td>
 					</tr>
 					{{/each}}
 				</tbody>

diff --git a/templates/SSDS-3.html.tmpl b/templates/SSDS-3.html.tmpl
@@ -280,7 +280,6 @@
                     <th>Version</th>
                     <th class="content-wrappable">Description of Functionality</th>
                     <th>References</th>
-                    <th class="content-wrappable">Installed by ODS</th>
                 </thead>
                 <tbody>
                     {{#each data.sections.sec5s1.components}}
@@ -291,7 +290,6 @@
                         <td class="content-wrappable">{{version}}</td>
                         <td class="content-wrappable">{{description}}</td>
                         <td class="content-wrappable">{{references}}</td>
-                        <td class="content-wrappable">{{doInstall}}</td>
                     </tr>
                     {{/each}}
                 </tbody>

diff --git a/templates/SSDS-4.html.tmpl b/templates/SSDS-4.html.tmpl
@@ -280,7 +280,6 @@
                     <th>Version</th>
                     <th class="content-wrappable">Description of Functionality</th>
                     <th>References</th>
-                    <th class="content-wrappable">Installed by ODS</th>
                 </thead>
                 <tbody>
                     {{#each data.sections.sec5s1.components}}
@@ -291,7 +290,6 @@
                         <td class="content-wrappable">{{version}}</td>
                         <td class="content-wrappable">{{description}}</td>
                         <td class="content-wrappable">{{references}}</td>
-                        <td class="content-wrappable">{{doInstall}}</td>
                     </tr>
                     {{/each}}
                 </tbody>

diff --git a/templates/SSDS-5.html.tmpl b/templates/SSDS-5.html.tmpl
@@ -301,7 +301,6 @@
                     <th>Version</th>
                     <th class="content-wrappable">Description of Functionality</th>
                     <th>References</th>
-                    <th class="content-wrappable">Installed by ODS</th>
                 </thead>
                 <tbody>
                     {{#each data.sections.sec5s1.components}}
@@ -312,7 +311,6 @@
                         <td class="content-wrappable">{{version}}</td>
                         <td class="content-wrappable">{{description}}</td>
                         <td class="content-wrappable">{{references}}</td>
-                        <td class="content-wrappable">{{doInstall}}</td>
                     </tr>
                     {{/each}}
                 </tbody>

diff --git a/templates/TIP.html.tmpl b/templates/TIP.html.tmpl
@@ -147,7 +147,7 @@
                 Component repository is a <em>GIT</em> managed repository on validated <em>BI-AS-ATLASSIAN</em>.
             </li>
             <li>
-                Component inside a <em>GIT</em> repository is of type <em>ods</em>, <em>ods-infra</em>, <em>ods-saas-service</em>, <em>ods-service</em>, or <em>ods-test</em>. Components of type <em>ods-saas-service</em> are not installed by OpenDevStack, but by their respective manufacturer. Components of type <em>ods-test</em> are not installed, but contain automated end-to-end tests used to exercise the system. The foundation of those components, named <em>Boilerplates</em>, are qualified through the qualification of OpenDevStack (<em>ODS</em>, <em>BI-IT-DEVSTACK</em>) itself.
+                Components of type <em>ods-saas-service</em> are not installed by OpenDevStack, but by their respective manufacturer. Components of type <em>ods-test</em> are not installed, but contain automated end-to-end tests used to exercise the system. The foundation of those components, named OpenDevStack Quickstarters, are qualified through the qualification of OpenDevStack (<em>ODS</em>, <em>BI-IT-DEVSTACK</em>) itself.
             </li>
             <li>
                 Except for the <em>ods-saas-service</em> type, a component's <em>GIT</em> repository contains a Jenkins file (named Jenkinsfile), which is used for building, testing, and installation through the OpenDevStack Jenkins build engine.
@@ -165,30 +165,32 @@
 
         <h3 id="section_3_1"><span>3.1</span>Components Specification</h3>
         <p>The installation comprises the following software-defined components:</p>
-        Components where <em>Installation by ODS</em> is denoted as <em>false</em> are of type <em>ods-saas-service</em>, or <em>ods-test</em>.</p>
 
         <table>
             <thead>
                 <th class="content-wrappable">Software Module Name/ID</th>
                 <th class="content-wrappable">Manufacturer</th>
                 <th class="content-wrappable">Software Version / Language</th>
-                <th class="content-wrappable">ID of Component to be installed </th>
+                <th class="content-wrappable">Repository URL</th>
                 <th class="content-wrappable">Reference to System and Software Design Specifications</th>
+                <th class="content-wrappable">Included in the installation</th>
                 <th class="content-wrappable">Installation by ODS</th>
             </thead>
 			<tbody>
 				{{#each data.repositories}}
 				<tr>
 					<td class="content-wrappable">{{id}}</td>
-					<td class="content-wrappable">{{metadata.supplier}}</td>
-					<td class="content-wrappable" style="font-size: smaller">{{data.git.url}} branch {{data.git.branch}}, the actual commit is specified as parameter during installation</td>
-					<td class="content-wrappable">BI-AS-ATLASSIAN / Project: {{metadata.name}} // repo: {{id}}</td>
+					<td class="content-wrappable"><a style="color: inherit; text-decoration: inherit;" href="{{metadata.supplier}}" style="">{{printsupplier}}</a></td>
+					<td class="content-wrappable" style="font-size: smaller">{{#if include}}git branch  {{data.git.branch}} {{else}} N/A {{/if}}</td>
+					<td class="content-wrappable"><a style="color: inherit; text-decoration: inherit;" href="{{data.git.url}}" style="">{{printurl}}</a></td>
 					<td class="content-wrappable">{{../metadata.buildParameter.configItem}} / {{metadata.referencedDocs.SSDS}} System and Software Design Specification</td>
-					<td class="content-wrappable">{{doInstall}}</td>
+					<td class="content-wrappable">{{#if include}} Yes {{else}} No {{/if}}</td>
+					<td class="content-wrappable">{{#if include}} {{#if doInstall}} Yes {{else}} No {{/if}} {{else}} N/A {{/if}}</td>
 				</tr>
 				{{/each}}
 			</tbody>
         </table>
+        <p>Please consult the Technical Installation Report (TIR) for the actual git commit after installation.</p>
 
         <h3 id="section_3_2"><span>3.2</span>Verification of Delivery</h3>
         <p><em>N/A</em>. There is no shipment of hardware or software. The proper functionality of installed components is verified during verification phase of this installation.</p>
@@ -219,7 +221,7 @@
             </tr>
             <tr>
                 <td class="content-wrappable">Installation by ODS <em>{{id}}</em></td>
-                <td class="content-wrappable">{{doInstall}}</td>
+                <td class="content-wrappable">{{#if doInstall}} Yes {{else}} No {{/if}}</td>
             </tr>
             {{^doInstall}}
             <tr>