CHANGELOG.md

Changelog

Unreleased

Added

• add devcontainer setup (#1172)

Changed

• Enhance SSDS Document Generation Performance using New Atlassian APIs (#1084)
• Deprecation of vuln-type and scanners config in Trivy (#1150)
• Add preserve-digests cli option to skopeo copy command in CopyImageStage (#1166)
• Allow registry/image:tag sources in CopyImageStage instead of directly falling back to internal registry (#1177)

Fixed

• Fix Tailor deployment drifts for D, Q envs (#1055)

[4.6.0] - 2024-10-23

Changed

• Fail builds when aqua scan detects remotely exploitable security vulnerabilities with solutions (#1147)
• Fail the release manager pipeline and create security vulnerability issues or move them to TODO state if already present (#1151)
• Aqua log readability update and whitelisting mechanism fix (#1161)
• Aqua remotely exploitable critical vulnerabilities improvements (#1157)
• In the release manager pipeline, use the default integration branch for component (#1144)
• Use riskPriority value as number instead of its value as text in RA (#1156)

Fixed

• Fix branch calculation for re-deploy (#1162)
• Preserve quickstarter files in case a repository already contain files with same names (#1165)

[4.5.6] - 2024-09-16

Fixed

• Even if the POO property is set a true, this information is not present in the RA generated (#1154)

[4.5.5] - 2024-08-26

Fixed

• Fix NPE when the test type is null (#1146)

[4.5.4] - 2024-07-17

Changed

• In test results, labels not related to execution persist (#1138)

Fixed

• Fix excluded ods-infra components failing on deploy stage (#1139)
• Fix Finalize stage for ods-library components (#1140)

[4.5.3] - 2024-07-08

Fixed

• Fix deploy error for missing Jira config (#1136)

[4.5.2] - 2024-06-25

Fixed

• Fix to generate TIR information in QA and PROD for helm components (#1133)

[4.5.1] - 2024-06-19

Fixed

• Fix to use the correct wiki formatting from jira plugin api(#1128)

[4.5.0] - 2024-06-06

Fixed

• Preload images into the cluster before initiating the rollout process using Helm (#1026)
• Fix ods-deployments file repeats image in mono repository setup (#1011)
• Fix Globally injected variables do not work in subcharts/dependencies (#1066)
• Fix retrieval of SonarQube quality gate (#1109)
• Fix SonarQube Pull Request code insights link not pointing to the branch scanned (#1112)
• Fix NexusService methods that were not obtaining the x2 account when pushing and retrieving artifacts (#1121
• Context variables nexusUsername and nexusPassword are set again by nexusService (#1124
• The Document History indicates clearly when an SLC document has not changed (#1115)
• Fix using repo variable before declaration (#1117)

Added

• Included the complete Requirement description to Risk Assessment Table (#1098)
• Add dependency updates for Gradle via dependabot (#1040)
• Support deployment with only selected components (#1081)

Changed

• Improve messages in Helm deployment issues with custom chartDir option (#1044)
• Substitute env username and password variables for nexus by using instead Jenkins variable "cd-user-with-password" (#1118)

[4.4.0] - 2024-04-22

Fixed

• Fix documentation refers to qs with prefix infra- however there are only inf- quickstarters (#1060)
• Fix excessive number of Api calls to Jira to retrieve the last document version (#654)

Added

• Add Openshift appDomain context value in Quickstarter pipeline, optimize the way to get appDomain from cluster (#997)

Changed

• Update api version in ocp templates for image, buildconfig, route and deploymentconfig (#1072)

[4.3.4] - 2024-02-20

• Fix documentation refers to qs with prefix infra- however there are only inf- quickstarters (#1060)
• Fix ods-deployments file repeats image in mono repository setup (#1011)
• Fix parameter count warning in (86e1d)
• Remove jvmArgs "-XX:MaxPermSize=256m" from build.gradle as it is no longer supported (See https://docs.oracle.com/javase/9/migrate/#GUID-1F270BDA-50B0-49C8-807E-0B727CCC5169)
• Aqua scanner and Helm deployment conflict fix for jenkins shared library (#1067)
• Fix ods-infra components require OpenShift projects in Deploy stage (#1047)

[4.3.3] - 2023-11-07

• Add better documentation for Helm (#1027)
• Avoid Groovy string interpolation #1030

Added

• Add done boolean flag to data passed to the document template service (#1048)
• Add better documentation for Helm (#1027)

Changed

• Remove drift alignment code and pause deploy mechanism (#1054)

Fixed

• Generate TRC document in D environment instead of Q (#1029)

• Avoid Groovy string interpolation #1030

[4.3.2] - 2023-10-02

Fixed

• Fix slow helm component deployments sometimes fail at the finalize step (1031)
• Fix blurred images retrieved from Jira in the document chapters (1022)
• Align tailor drift check for D, Q envs (#1024)

[4.3.1] - 2023-07-12

Fixed

• Fix SonarQube quality gate report to use the pull request or branch in scope (#1016)
• CURL command fix for the sonarqube quality gate report retrieval (#1020)
• Fix typos in build.gradle (#1012)

[4.3.0] - 2023-07-03

Added

• Make IS_GXP property available for CFTP documents (#996)
• Add Trivy stage for security scanning (#1008)

Changed

• Use a consistent notion of document version and remove header (#987)
• Improve Document Generation Experience (#991)
• Update Reference Documents & Base Documents sections (#994)
• Updated functional tests after fix SSDS appendix per gamp and RA chapter 5 (#103)
• Change initial project validation to take into account non GxP requirement (#1007)
• Show warn in Jira comment only if WIP issues exist (#1010)
• Change default registry to match Openshift 4 ([#983] (#983))

Fixed

• Fix helm release - Check pod status after deployment (#1005)
• Moving from rollout pause/resume to patching resources to avoid errors in case of inconsistent state (#1013)
• Memory leak fixes for component pipeline (#857)
• Fix Component fails to deploy with more than one DeploymentConfig(#981)
• Fix errors when the templatesVersion is not set or set as number (#1000)

[4.2.0] - 2023-02-21

Added

• Add Helm Support to Release Manager (#866)
• Add project property PROJECT.IS_GXP (#963)
• Support Trivy premium CLI (scannercli) in Aqua server with new Trivy Enterprise engine (#964)

Changed

Fixed

• Fix tests that failed when running on Windows (#966)
• Deploy into Q without git tags fails (#967)
• Fix Deployment rollout doesn't support replicas=0 (#969)
• Fix Aqua scan support for mono repo (#916)

[4.1.0] - 2022-11-17

Added

• Add new Infrastructure Service (#740)
• Add annotation to agents by default (#879)
• Added default timeout to Aqua stage (#899)
• Add retry for Openshift image build status (#901)

Changed

• Better handling of Unit tests in D and DevPreview (827)
• Remove call to a cps method from a non_cps method (852)
• Improve error message when two coded tests are linked to the same test issue (#835)
• Set test summary for empty description in TCR (#837)
• Closes (#857)
• Increase default timeout for rollout (#903)
• Removes DIL from the set of docs generated for enviroment P (#914)
• Developer preview uses the release branch if exists, the branch in Release Manager s metadata.yml cfg if not (#920)
• Allow to redeploy to D, Q and P, by setting repromote to true by default and creating tags only if they do not exist (#926)

Fixed

• Fix RM: found unexecuted Jira tests error during promote2Production when functional test only runs on D and QA (#832)
• Fixed redeploy to P (#947)
• Fixed RPN and RP Risk Assessment fields to display proper values when not null (#956)
• Fixed errors in library (Null pointers and Serialization) (#941)
• Fixed document history path in IVP and IVR (#944)
• Fix resolveJiraDataItemReferences create list with null (#864)
• JiraService.createIssueType(JiraService.groovy:194) fails when description is missing (#894)

[4.0] - 2022-11-10

Added

• Add functional test to LevaDoc (#697)
• Add labels to generated OpenShift resources (#646)
• Added builder (agent and master) labels into image building process (#644)
• Added regexp compatibility with new Bitbucket merge commit messages (#655)
• Add recommended labels to pods (#686)
• Added data for Risk Assesment document (687)
• Modified SSDS document to use Pull Request info not SonarQube (#614)
• Added Aqua Stage (#661, #617)
• Add Technical Specifications and risks related to technical specifications to the TRC document (#690)
• Enable the co-existence of multiple E2E test components (#377)
• Integrate SonarQube scan results with Bitbucket (#698)
• Provide init hook for test quickstarters to better plug into RM (#699)
• Documented the labeling functionality (#715)
• Add support for ods-saas-service components (#607)
• Add breakable characters in SSDS Bitbucket data to let the render split the words ([#774])(#774))
• Update Aqua doc (#803)
• Introduce ods-library component type (#603)
• RM: deploy phase verifies target project and login, even if there are only non-installable components(#810)
• RM: test-stage fails /with unstash exception/ if no installation/integration/acceptance test results are provided(#811)
• Release Manager references v1.1 SLC Docs templates (#798)
• Improve Wiremock logs (#809
• Improve error message when two coded tests are linked to the same test issue (#826)
• Set test summary for empty description in TCR for acceptance tests (#844)
• Bump Antora page version in master (opendevstack/ods-documentation#66)
• Improve memory cleanUp (#902)

Changed

• Throw exception when two coded tests are linked to the same test issue (#737)
• Throw controlled exception when testIssue has no component assigned (#693)
• Early stop on opened Jira issues before deploy to dev environment (#626)
• Change association with the current release in the test cycles of previewed execution (#638)
• Set jenkins job to unstable in case of open issues (#664)
• Automatically change the date_created by Wiremock with a Wiremock wildcard (#743)
• Refactor and create unit test for LeVADocumentUseCase.getReferencedDocumentsVersion (#744)
• Rollback changes filtering components for TIP (#762)
• Set test summary for empty description in TCP (816)
• Change some Exception messages for clarity, consistency and typos (780)
• Change document generation order (#773)
• Rerunning of master pipeline after dev release via release-manager (#793)
• Increase Socket Timeout on Pipeline Orchestrator (#781
• Increase Socket Timeout on Pipeline Orchestrator in NonCPS (#782

Fixed

• Fixing an error when reimplementing from Deploy to D to WIP, it was using a release branch but trying to commit master branch (#951)
• Prevent Jenkins nonCPS error after reporting bug (#776)
• Fixed the Developer Preview fails because "Duplicated Tests"
• Fix sort tests steps in TCP and TCR documents (#652)
• Fixed environment value of SonarQube edition (#618)
• Fixed the Document History of the IVP & IVR is not being generated (#627)
• Fixed Test name/summary in DTP/DTR documents (#625).
• Fix A "null" string is added in the Section 3.1 of the CFTR when the Description of the Zephyr Unit Test doesn't has a Description (#634)
• Orchestration pipeline throws a non serializable exeption issue 645 (#649)
• Fixed bug that disallowed empty label values (#655)
• Fixed regression on project dump in release manager (#666)
• Fixed use of full image in the creation of the documents (682)
• Fix epic Issues not correctly ordered on the CSD (#671)
• Fix Reference Documents not displaying the correct version on the SLC Documents (#672)
• Jenkins nonCPS prevents project.dump from work (#673)
• Regression from NonCPS refactoring leads to method not found (#675, (#678)
• Fix reference Document Version for the DTR and TIR are not correct (#681)
• Fix the referenced documents are not displaying the correct version if they are generated after the SLC Document (#685)
• Fix Document History in TIR and IVR is not correct after de deploy to P (#695)
• Fix NonCPS error in thumbnail replacement (#704)
• Fix wrong entry in the document history when a new component is added (#702)
• Fix referenced document versions after PR [#691] (#709)
• Fix missing grapes import in BitbucketService [#717] (#717)
• Fix by default sonarQu should analyzePullRequests:false (#663)
• Fix RA table overflow replacing unicode character in jira keys (#735)
• Fix CNES report is executed too soon in the Sonar Scanner stage (#732)
• Fix SerializationException, Fix NULL in SSDS generation and Fix SaaS bug in FinalizeStage (#756)
• Fix null in RA (#772)
• Fix null in SSDS when no reviewer in a PR (#779)
• While deploying on Qa with 1 bug, 3 bugs are reported instead of 1 (#757
• Fix Traceability matrix to not show Unit Tests (#799
• Fix Traceability matrix null error (#817)
• Problems with temporal folder in tests (#819
• RM: test component causes new jenkins (run) instance after branch is created for release(#823)
• Fix the SCR table in SSDS (chapter 2.3) appears cut off (#843)
• JiraService.createIssueType(JiraService.groovy:194) fails when description is missing (#894)
• Fix resolveJiraDataItemReferences create list with null (#864)
• Fixed uploading of artifacts to 'pypi' repositories (#785)
• Fix Aqua integration fails for future versions (#875)
• Fix nexus pypi upload (#812)
• Fix return image build info in odsComponentStageBuildOpenShiftImage (#909)
• Fixed errors in library (Null pointers and Serialization) (#941)
• Fix when the git checkout raise an Exception, the RM is not informed because the Registry is not initialized. ([#938]#938)
• Fixed document history path in IVP and IVR (#944)
• Fixed redeploy to P (#947)
• Fixed RPN and RP Risk Assessment fields to display proper values when not null (#956)
• Redeployments to QA cause detached Tags (#960)

Removed

• Remove the workaround for NPE resolving issues (#660)
• Remove not needed entries in the CFTP document history (#707)
• Remove non-breakable white space from Json response of JiraService (760)
• Remove support for the url repository field in metadata.yml (#954)

[3.0] - 2020-08-11

Added

• Allow execution of e2e in the same Jenkins of the ODS-CI (#716)
• Merge (ods-mro-shared-library) into this library, and consolidate services (#271)
• Allow configuration of docker context directory (#181)
• Add harmonized stage names based on the new library layout (#215)
• Introduce CodenArc for scanning of the shared lib (#290)
• Add global var withOpenShiftCluster (#412)
• Add stage to import image and automatically import if possible (#400)
• For agents image configuration - check availability of image & set timeout to connect (#391)
• add withStage for quickstarters (#378)
• (Optionally) Deploy via Tailor (#96)
• Allow configuration of BB project (#317)
• Make ODS namespace configurable (#312)
• Document params to odsPipeline (#126)
• quickstarters/pushToRemoteStage should support existing local git repo (#265)
• New quickstarter stage initRepoFromODS (#268)
• Jenkins shared library should support monorepo - multi build / deploy (#222)
• Get last successful build (#155)
• Integrate SonarQube with pull requests (#174)
• Add quickstarter pipeline (#230)
• Support for dynamic injection of /docs folder into Dockerfile and MRO label support (#229)
• ods-pipeline should have 2 more stages (start / finish) (#201)
• verbosity of standard shared libary stages (#196)
• Allow easy configuration of compute resources (#173)
• Fix rollout race condition and display events in Jenkins log (#385)
• Fix image not shown in documents like TIR and DTR from Document Chapters (#789)

Changed

• Lazily set OpenShift app domain (#396)
• bitbucket status setting in MRO on fail (#370)
• Skip shared lib build / deploy if commits did not change (#103)
• Ease and document Tailor-based preview deploy (#340)
• consistently use logger throughout all the shared lib (#326)
• Orchestration Pipeline: Merge released code back into main branch (#367)
• Use URLs consistently (#366)
• MRO performance on large application (#348)
• Merge OpenShiftService (#273)
• Unify script/steps approach (#276)
• Merge GitUtil into GitService (#285)
• Move JenkinsService (#275)
• Move NexusService (#274)
• MRO should update commits of repos (incl self) it builds with Jenkins build job status (#278)
• Set default branch to master instead of production (#321)
• DTR should also work with non jira configuration (#277)
• MRO - rework overall report creation (and single store) logic (#310)
• Use ods namespace instead of cd (#316)
• Remove DevelopersRecipientProvider from email recipients (#309)
• PROJECT_ID parameter should be transformed to all lowercase (#314)
• Ensure context.projectId is lowercase (#313)
• Misleading Documentation In Customizing Slaves (#304)
• Merge ServiceRegistry (#272)
• infer Project id and component from the git url of the repo instead of coding them into the jenkinsfile (#266)
• Refactor component/uploadToNexus (#269)
• Refactor Pipeline to use services (#249)
• Reduce surface of component context (#252)
• Allow to configure imageStreamTag instead of image (#233)
• Convert Snyk stage to new style (#228)
• ScanForSonarqube stage should pass author to cnes report creator (#197)
• Convert SonarQube stage to new style (#226)
• Extract stages into classes (#221)
• Print out assembled information only in debug mode (#171)
• Make docker dir configurable (#188)
• Expose bitbucketUrl, taken from BITBUCKET_URL if present (#182)
• tedious to test and make changes in auto clone scripts (#167)

Fixed

• Quickstarter PushToRemoteStage - cannot configure branch to be pushed (#424)
• Concurrency - grape load fails during shared lib compile (#422)
• Resolve only JiraDataTypes in Project (#416) (#418)
• Rollout should not fail when containers point to images from Docker Hub directly (#407)
• Environment mapping broken when using multiple odsComponentPipelines (#394)
• Snyk monitor command for Gradle based projects fails (#398)
• Run Snyk monitor command within env block (#399)
• race condition: deployment logic & tagging sometimes makes MRO fail (#382)
• ods quickstarter pipeline does not show any stages in stageview (#376)
• MRO Test / Build stage duplicate lots of code (#359)
• autocloning no longer works - route creation ahead fails (#350)
• Fix various smaller issues (#352)
• ensure all credentials are masked in output logs (#212)
• Image sha cannot be resolved on promotion to other cluster (#343)
• Allow repo name which does not follow - pattern (#327)
• Checking odsComponentPipeline argument input types (#315)
• Nexus password in plain text at the $JenkinsLog on a quickstarter build (#288)
• SnykService calls to snyk cli always return true (#258)
• Bitbucket not recognizing last successful build after a failed one (#300)
• Remove Logger#error (#291)
• component/scanWithSonarStage should use the projectId/componentId from context instead of hard coding projectKey (#267)
• Refactor pipeline - MRO changes / cleanups (#257)
• Using base image from other namespace did not work (#179)
• Fix build args patches (#236)
• stageScanForSonarqube lacks verbosity (#193)
• ciSkip check happens on slave node rather than master (#199)
• Hard coded protocol in OdsPipeline.groovy breaks Jenkins Build (#74)
• Build is still "running" after it finishes (#189)
• oc rollout output parser does not work always (#184)

Removed

• Remove OWASP support (#225)

[2.0] - 2019-12-13

Added

• Optionally fail Jenkins if SonarQube scan fails (#22)
• Improve deployment stage, e.g. rollout manually when no triggers are defined (#144)

Changed

• Method environmentExists check exists twice (#138)

Fixed

• Snyk scan may fail because Nexus is not configured properly (#156)
• Seldom error in stageDeployToOpenshift (ArrayIndexOutOfBounds)- when checking for new deployment (#142)
• Special characters in last commit message break build (#158)
• Find last build in stageStartOpenshiftBuild fails on some clusters (#159)

[1.2.0] - 2019-10-10

Added

• Make ODS pipeline configurable for MRO (#97)
• Make jenkins ods shared lib ready for MRO (#108)

Fixed

• Job fails when using a custom test reports location (#132)
• Seldom failure (OCP Build app-be-bonjour-451 was not successfull - status Running) - although build completed in same var / stage(#135)
• Fix build still running issue during build check (#136)
• Auto Clone Environment fails during curl download (#109)
• Set memory explicitly for Jenkins slave pods (#114)
• Shared lib clone environment always stores @master in oc-config-artifacts (#105)
• Build Openshift Image stage fails if the committer has an apostrophe in their name (#130)

[1.1.0] - 2019-05-28

Added

• Dump generated BC labels into file (release.json) during jenkins build (#89)
• Allow to skip builds (#45)
• Allow to configure build args (#61)
• Add stage to produce / export CNES / SQ report (#46)

Fixed

• ' in commit message breaks stage "Build Openshift Image" (#86)
• withCredentials expands $ sign - leading to bitbucket errors (#87)
• Pod label is always unique (#83)
• NullPointerException if error occurs during prepare stage (#68)

Changed

• Builder Pods should run with jenkins SA rather than default SA (#64, #78)

[1.0.2] - 2019-04-02

Added

• Image author / commit empty in oc image built thru jenkins shared lib (#47)

[1.0.1] - 2019-01-25

Changed

• Retry setting build status twice (#57)

Fixed

• Serialization error when branch prefix is used in environment mapping (#58)

[1.0.0] - 2018-12-03

Added

• Allow to take full control over the pod containers of the build slave (#35).
• Allow to start build in OpenShift directly from artifacts produced in the Jenkins pipeline. This removes the need to upload the artifacts to Nexus and then download them again in the Dockerfile. To use, replace stageUpdateOpenShiftBuild with stageStartOpenShiftBuild and adapt the Dockerfile accordingly. See #8.
• Set build status for each commit in BitBucket. This allows to require successful builds before PRs can be merged. See #14.
• Pulling of images can be disabled by setting podAlwaysPullImage: false. See #6.
• Debug mode (#30, #38)

Changed

• Rework the mapping between branches, pipelines and OpenShift environments. Please see the readme for details of the new semantics.
• Ensure environment variables are present in prepare phase. See #4.
• Move OCP environment cloning / build triggering to master node (#43)

Fixed

• Fix and simplify checkout logic in pipeline (#44)

Removed

• Verbose mode (#30)
• stageUpdateOpenshiftBuild - Use stageStartOpenShiftBuild instead (#8)

[0.1.0] - 2018-07-27

Initial release.