diff --git a/CHANGELOG.md b/CHANGELOG.md index b40a508..8915216 100644 --- 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 index 457ebc4..2cd8580 100644 --- a/templates/IVP.html.tmpl +++ b/templates/IVP.html.tmpl @@ -109,7 +109,7 @@ {{id}} {{type}} - {{doInstall}} + {{#if doInstall}} Yes {{else}} No {{/if}} {{/each}} diff --git a/templates/IVR.html.tmpl b/templates/IVR.html.tmpl index 8344299..85ccdad 100644 --- a/templates/IVR.html.tmpl +++ b/templates/IVR.html.tmpl @@ -111,14 +111,12 @@ Component Name Repository Type - Installed by ODS {{#each data.repositories}} {{id}} {{type}} - {{doInstall}} {{/each}} diff --git a/templates/Overall-TIR-Cover.html.tmpl b/templates/Overall-TIR-Cover.html.tmpl index 9ed9bd0..19b792b 100644 --- a/templates/Overall-TIR-Cover.html.tmpl +++ b/templates/Overall-TIR-Cover.html.tmpl @@ -85,7 +85,7 @@

1Installed Component Summary

- 

Based on the component type, as mentioned in the TIP, the following components were installed, and where applicable:
+ 

The following components were installed by ODS, and where applicable, these additional tasks were done:
diff --git a/templates/RA.html.tmpl b/templates/RA.html.tmpl index 7860679..2a816c5 100644 --- a/templates/RA.html.tmpl +++ b/templates/RA.html.tmpl @@ -148,13 +148,11 @@ Identifier of the risk for reference within other documents - Requirement No. - Unambiguous reference to a specific requirement, function or a group of requirements in a reference document. The prefix indicates the referenced document - - - Requirement Summary - Short description of requirement or function - + Requirements + Requirement No: Unambiguous reference to a specific requirement, function or a group of requirements in a reference document.
+ Requirement Summary: Short description of requirement or function.
+ Requirement Description: Detailed description of requirement or function. + GxP Relevance of the requirement or function for GxP or non-GxP (e.g. business). See section 4.2.1 @@ -407,8 +405,7 @@ - - + @@ -423,10 +420,11 @@ {{#each data.sections.sec5.risks }} - - + - + diff --git a/templates/SSDS-1.html.tmpl b/templates/SSDS-1.html.tmpl index 1e01099..726128e 100644 --- a/templates/SSDS-1.html.tmpl +++ b/templates/SSDS-1.html.tmpl @@ -262,7 +262,6 @@ - {{#each data.sections.sec5s1.components}} @@ -273,7 +272,6 @@ - {{/each}} diff --git a/templates/SSDS-3.html.tmpl b/templates/SSDS-3.html.tmpl index a2ab892..2e6e3ec 100644 --- a/templates/SSDS-3.html.tmpl +++ b/templates/SSDS-3.html.tmpl @@ -280,7 +280,6 @@ - {{#each data.sections.sec5s1.components}} @@ -291,7 +290,6 @@ - {{/each}} diff --git a/templates/SSDS-4.html.tmpl b/templates/SSDS-4.html.tmpl index 1f29ca0..6ff7d99 100644 --- a/templates/SSDS-4.html.tmpl +++ b/templates/SSDS-4.html.tmpl @@ -280,7 +280,6 @@ - {{#each data.sections.sec5s1.components}} @@ -291,7 +290,6 @@ - {{/each}} diff --git a/templates/SSDS-5.html.tmpl b/templates/SSDS-5.html.tmpl index b428756..756ce2b 100644 --- a/templates/SSDS-5.html.tmpl +++ b/templates/SSDS-5.html.tmpl @@ -301,7 +301,6 @@ - {{#each data.sections.sec5s1.components}} @@ -312,7 +311,6 @@ - {{/each}} diff --git a/templates/TIP.html.tmpl b/templates/TIP.html.tmpl index ab0b8a9..4db4d21 100644 --- a/templates/TIP.html.tmpl +++ b/templates/TIP.html.tmpl @@ -147,7 +147,7 @@ Component repository is a GIT managed repository on validated BI-AS-ATLASSIAN.
  • - Component inside a GIT repository is of type ods, ods-infra, ods-saas-service, ods-service, or ods-test. Components of type ods-saas-service are not installed by OpenDevStack, but by their respective manufacturer. Components of type ods-test are not installed, but contain automated end-to-end tests used to exercise the system. The foundation of those components, named Boilerplates, are qualified through the qualification of OpenDevStack (ODS, BI-IT-DEVSTACK) itself. + Components of type ods-saas-service are not installed by OpenDevStack, but by their respective manufacturer. Components of type ods-test 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 (ODS, BI-IT-DEVSTACK) itself.
  • Except for the ods-saas-service type, a component's GIT 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 @@

    3.1Components Specification

    The installation comprises the following software-defined components:

    - Components where Installation by ODS is denoted as false are of type ods-saas-service, or ods-test.

    • Risk No.Requirement No.Requirement SummaryRequirements GxP (see 4.2.1) Description of risks/failures (or reason for GxP = No) Prob. Occur.
    {{key}}{{{requirementsKey}}}{{{requirements}}} + {{requirement.key}}: {{requirement.name}}.
    {{{requirement.description}}} +     		{{gxpRelevance}}Summary:{{name}}.
    {{{description}}}    		Summary: {{name}}.
    {{{description}}}    		 {{probabilityOfOccurrence}} {{severityOfImpact}} {{probabilityOfDetection}}Version Description of Functionality ReferencesInstalled by ODS
    {{version}} {{description}} {{references}}{{doInstall}}
    Version Description of Functionality ReferencesInstalled by ODS
    {{version}} {{description}} {{references}}{{doInstall}}
    Version Description of Functionality ReferencesInstalled by ODS
    {{version}} {{description}} {{references}}{{doInstall}}
    Version Description of Functionality ReferencesInstalled by ODS
    {{version}} {{description}} {{references}}{{doInstall}}
    - + + {{#each data.repositories}} - - - + + + - + + {{/each}}
    Software Module Name/ID Manufacturer Software Version / LanguageID of Component to be installed Repository URL Reference to System and Software Design SpecificationsIncluded in the installation Installation by ODS
    {{id}}{{metadata.supplier}}{{data.git.url}} branch {{data.git.branch}}, the actual commit is specified as parameter during installationBI-AS-ATLASSIAN / Project: {{metadata.name}} // repo: {{id}}{{printsupplier}}{{#if include}}git branch {{data.git.branch}} {{else}} N/A {{/if}}{{printurl}} {{../metadata.buildParameter.configItem}} / {{metadata.referencedDocs.SSDS}} System and Software Design Specification{{doInstall}}{{#if include}} Yes {{else}} No {{/if}}{{#if include}} {{#if doInstall}} Yes {{else}} No {{/if}} {{else}} N/A {{/if}}
    +

    Please consult the Technical Installation Report (TIR) for the actual git commit after installation.

    3.2Verification of Delivery

    N/A. There is no shipment of hardware or software. The proper functionality of installed components is verified during verification phase of this installation.

    @@ -219,7 +221,7 @@ Installation by ODS {{id}} - {{doInstall}} + {{#if doInstall}} Yes {{else}} No {{/if}} {{^doInstall}}