Feature/301 create utility scripts to compute the next release build for cbs #310

monvora · 2025-04-11T13:14:03Z

Add shell script to compute the next release version: computeReleaseVersion.sh
Add Jenkins pipeline definition template that perform deployment through Wazi Deploy

Signed-off-by: Dennis Behm <[email protected]>

Co-authored-by: Mathieu Dalbin <[email protected]>

Signed-off-by: Dennis Behm <[email protected]>

…utility-scripts-to-compute-the-next-release-build-for-CBS

dennis-behm

@monvora can you please address:

permission bits - a lot got changed (I assume unintentionally)
update the README that this new script is available
minor comment.

The updates of the pipeline template should be planned in dedicated pull requests that are already captured in #311

dennis-behm · 2025-04-28T09:21:45Z

Templates/Common-Backend-Scripts/computeReleaseVersion.sh

+  export mainBranchSegment=`echo ${Branch} | awk -F "/" '{ print $1 }'`
+  export secondBranchSegment=`echo ${Branch} | awk -F "/" '{ print $2 }'`
+  export thirdBranchSegment=`echo ${Branch} | awk -F "/" '{ print $3 }'`
+  echo $PGM": [INFO] Branch segments: ${mainBranchSegment}, ${secondBranchSegment}, ${thirdBranchSegment}"


I think we can remove this print. It is a big confusing.
Maybe put it into a comment and add a comment that this is for debugging.

Thank you @dennis-behm for a review. I made all the changes we discussed. Now the PR contains:

computeReleaseVersion.sh script to compute the next release version.

Updated readme.md which documented about computeReleaseVersion.sh

Please have another reveiw.

dennis-behm

@monvora - can you please add a section to the README about this new script, please?

…nor update to the computeReleaseVersion.sh script based on Dennis's feedback

monvora · 2025-04-29T08:56:05Z

@monvora - can you please add a section to the README about this new script, please?

Done...

dennis-behm

@monvora Thanks for the documentation updates. I tested your script and this caused a set of new ideas. Can you please check my comments below?

Templates/Common-Backend-Scripts/computeReleaseVersion.sh

dennis-behm · 2025-04-29T09:02:17Z

Templates/Common-Backend-Scripts/computeReleaseVersion.sh

+      echo $PGM": [INFO] Baseline reference: ${baselineRef}"
+
+      computeNextReleaseVersion
+      export releaseVersion="rel-"${newVersion}


Please check if newVersion was computed - basically if it is "set" like the other environment variables. If the variable is empty, set RC=8.

dennis-behm · 2025-04-29T09:03:08Z

Templates/Common-Backend-Scripts/README.md

@@ -133,7 +133,8 @@ Artifact Name |  Description | Script details
 ---------- | -----| -----------------------------------------------------
 [gitClone.sh](gitClone.sh) | Pipeline Shell Script to perform Git Clone to z/OS UNIX System Services | [script details](README.md#41---gitclonesh)
 [dbbBuild.sh](dbbBuild.sh) | Pipeline Shell Script to invoke the Dependency Based Build framework [zAppBuild](https://github.com/IBM/dbb-zappbuild) | [script details](#dbbbuildsh-for-zappbuild-frameworkh)
-[zBuilder.sh](zBuilder.sh) | Pipeline Shell script to invoke the zBuilder framework [zBuilder](https://www.ibm.com/docs/en/dbb/3.0?topic=building-zos-applications-zbuilder) | [script details](#zbuildersh-for-dbb-zbuilder)
+[zBuilder.sh](zBuilder.sh) | Pipeline Shell Script to invoke the zBuilder framework [zBuilder](https://www.ibm.com/docs/en/dbb/3.0?topic=building-zos-applications-zbuilder) | [script details](#zbuildersh-for-dbb-zbuilder)
+[computeReleaseVersion.sh](computeReleaseVersion.sh) | Pipeline Shell Script to compute the next release version based on the baseline version information stored in the [baselineReference.config](samples/baselineReference.config) file. | [script details](#computeReleaseVersionsh)


Suggested change

[computeReleaseVersion.sh](computeReleaseVersion.sh) | Pipeline Shell Script to compute the next release version based on the baseline version information stored in the [baselineReference.config](samples/baselineReference.config) file. | [script details](#computeReleaseVersionsh)

[computeReleaseVersion.sh](computeReleaseVersion.sh) | Pipeline Shell Script to compute the next release version based on the baseline version information stored in the application's [baselineReference.config](samples/baselineReference.config) file. | [script details](#computeReleaseVersionsh)

dennis-behm · 2025-04-29T09:06:50Z

Templates/Common-Backend-Scripts/README.md

@@ -512,7 +564,8 @@ For release builds (that use the `pipelineType=release`), the archive is uploade
 `release/<reference>/<application>-<buildIdentifier>`:

 * **release** is defined for release builds. 
-* **reference** is the release name: for instance, `rel-1.2.3` (provided through the mandatory `-r` argument).
+* **reference** is the release name: for instance, `rel-1.2.3` (provided through the mandatory `-r` argument). The release name can be automatically computed using the [computeReleaseVersion.sh](#computereleaseversionsh) script.


Can we extend the packageBuildOutputs.sh to accept a new flag like -R (requires some analysis), which then calls computeReleaseVersion.sh as a utility program.

This will reduce the necessary communication between the pipeline orchestrator and the mainframe (keeps the pipeline implementation simpler).

@dennis-behm I like this idea. The pipeline implementation will definitely simpler. I will made all the changes you suggested above to close this PR. Then, I'll look into extending the packageBUildOutputs.sh script.

dennis-behm · 2025-04-30T11:41:22Z

Templates/Common-Backend-Scripts/computeReleaseVersion.sh

+  getBaselineReference
+  if [ $rc -eq 0 ]; then
+      ERRMSG=$PGM": [INFO] Baseline reference: ${baselineRef}"
+      eecho $ERRMSG


Suggested change

eecho $ERRMSG

echo $ERRMSG

Done and tested

dennis-behm · 2025-04-30T11:42:44Z

Templates/Common-Backend-Scripts/computeReleaseVersion.sh

+         ;;
+        *)
+            rc=8
+            ERRMSG=$PGM": [ERROR] Release type can only be Major, Minor or Patch. rc="$rc


Suggested change

ERRMSG=$PGM": [ERROR] Release type can only be Major, Minor or Patch. rc="$rc

ERRMSG=$PGM": [ERROR] No valid release type found. Valid release types are 'major', 'minor' or 'patch'. rc="$rc

dennis-behm

@monvora I have a few more comments. Please see below. Thank you.

dennis-behm · 2025-04-30T11:46:53Z

Templates/Common-Backend-Scripts/computeReleaseVersion.sh

+    echo $ERRMSG
+  fi
+
+  tmp2=$(echo $ReleaseType | tr '[:upper:]' '[:lower:]')


I think this section could lead to a wrong behaviour. We should not set a default.

Templates/Common-Backend-Scripts/computeReleaseVersion.sh

dennis-behm · 2025-04-30T11:48:56Z

Templates/Common-Backend-Scripts/computeReleaseVersion.sh

+        ERRMSG=$PGM": [INFO] Compute the next release version complete. The next release version: ${releaseVersion}. rc="$rc
+        echo $ERRMSG
+      else
+        ERRMSG=$PGM": [ERROR] Compute the next release version failed. Check Console for details. rc="$rc


Suggested change

ERRMSG=$PGM": [ERROR] Compute the next release version failed. Check Console for details. rc="$rc

ERRMSG=$PGM": [ERROR] Compute the next release version failed. Check console for details. rc="$rc

dennis-behm · 2025-04-30T11:53:19Z

Templates/Common-Backend-Scripts/computeReleaseVersion.sh

+      computeNextReleaseVersion
+
+      if [ $rc -eq 0 ]; then
+        export releaseVersion="rel-"${newVersion}


How will we pick up (grep) the next release version from the pipeline orchestrators (for example to set the git tag)

Do we want to print something like

releaseVersion=rel-1.4.0

so the pipelines could grep it like we do grep the url for the package:
https://github.com/IBM/dbb/blob/main/Templates/Common-Backend-Scripts/utilities/packagingUtilities.sh#L131

@dennis-behm, earlier when we planned to have this as the core CBS script, the way I implemented is for pipeline to extract the info from the output line after ([INFO] Compute the next release version complete. The next release version: ${releaseVersion}. rc="$rc). As discussed in one of our call, 'grep' isn't working to pass the version value from script running on USS to the orchestrator.

I was thinking of modify this later when I update this script to be utility script and extend the packageBuildOutput.sh to invoke the script.

Is it ok to wait for the next PR or shall I start working on changing it to utility script in this PR (along with extending packageBuildOutput.sh and probably wazideploy-generate.sh)

Got it about the pipeline orchestrators ✅ I am good with this.

A primary script could be included into the packageBuildOutput.sh and wazideploy-generate.sh.

Can we run an analysis and deliver the updates for packageBuildOutput.sh and wazideploy-generate.sh with this PR?

We have a similar approach in the scripts for the build stage to invoke a utility to fetch the dependencies.
https://github.com/IBM/dbb/blob/main/Templates/Common-Backend-Scripts/dbbBuild.sh#L442
the method leverages existing variable names.

@dennis-behm Thank you for the feedback and sure, let me do the analysis and propose how we can update this PR for this.

@monvora thank your for playing back your analysis. Our conclusion is to keep the computeReleaseVersion.sh script as a standalone script.

There are no plans to directly integrate them into packageBuildOutput.sh and wazideploy-generate.sh. The reasons are specifically about the second script wazideploy-generate.sh:

We want this script to be able to run on different LPARs. Therefore we cannot assume that the application repository is available to compute the name from the baselineReference.

Recommendation is to control and pass this information via the pipeline implementation technology.

dennis-behm · 2025-05-06T10:23:10Z

Templates/Common-Backend-Scripts/README.md

+```
+computeReleaseVersion.sh -w MortApp/main/build-1 -a MortgageApplication -b main -r minor
+```
+


Can you please add a sample how to retrieve the result from the command from a pipeline script?

…e archestrator.

dennis-behm · 2025-05-07T07:53:41Z

Templates/Common-Backend-Scripts/README.md

+}
+
+```
+


@monvora this is missing the closing </details> tag. It looks like the rest of the page is truncated.

https://github.com/IBM/dbb/blob/76c8b1e5e344373e280eabb70f3585c0fd8945fe/Templates/Common-Backend-Scripts/README.md#packaging-stage

dennis-behm · 2025-05-07T07:56:12Z

Templates/Common-Backend-Scripts/README.md

+if (pMatcher.find()) {
+	def version = "${pMatcher.group()}"
+  if (version){
+    releaseVersion = version.substring(9,version.length()-6)


Hard-coding the length seems to be error-prone.

What about a rel-10.123.876. I did not test it, but I assume this would cut off some information.

@dennis-behm, in this case if the log message isn't changed, the information will not be lost since the end part is always at the position (string length - 6) because the last part of the log message is always '. RC=0'.

…e archestrator.

dennis-behm and others added 30 commits January 30, 2025 10:47

Fetch build dependencies based on AD

c8ca5db

Signed-off-by: Dennis Behm <[email protected]>

Missing import of Utilities

82a3809

Signed-off-by: Dennis Behm <[email protected]>

Align fetchDependencies script with Application Descriptor

e9eab81

Signed-off-by: Dennis Behm <[email protected]>

initial documentation

8de7794

Signed-off-by: Dennis Behm <[email protected]>

initial documentation

f584cfc

Signed-off-by: Dennis Behm <[email protected]>

Consolidate fetch script for both dbbBuild.sh and zBuilder.sh

9e98a02

Signed-off-by: Dennis Behm <[email protected]>

Set execute bits for zBuilder.sh

7b49b4e

Signed-off-by: Dennis Behm <[email protected]>

Update release info and add page break

ca23c00

Signed-off-by: Dennis Behm <[email protected]>

Doc updates from code review

98e9de0

Co-authored-by: Mathieu Dalbin <[email protected]>

Configure Cache directory

b87255e

Signed-off-by: Dennis Behm <[email protected]>

Configure Cache directory

9a1f583

Signed-off-by: Dennis Behm <[email protected]>

Configure Cache directory

e923fd2

Signed-off-by: Dennis Behm <[email protected]>

Configure Cache directory

8499816

Signed-off-by: Dennis Behm <[email protected]>

Add dbbCommunityRepoRoot

4a32af5

Signed-off-by: Dennis Behm <[email protected]>

Read Application Descriptor via utils

27587cf

Signed-off-by: Dennis Behm <[email protected]>

Read Application Descriptor via utils

7e1ac6d

Signed-off-by: Dennis Behm <[email protected]>

Read Application Descriptor via utils

88f2df3

Signed-off-by: Dennis Behm <[email protected]>

Update Packaging process

2881037

Signed-off-by: Dennis Behm <[email protected]>

Update Packaging notes

d4bd7dd

Signed-off-by: Dennis Behm <[email protected]>

packageUtils

4aba150

Signed-off-by: Dennis Behm <[email protected]>

Add eyecatcher to build frameworks

43797c7

Signed-off-by: Dennis Behm <[email protected]>

why on earth again

4b25d17

Signed-off-by: Dennis Behm <[email protected]>

bla

2d9da76

Signed-off-by: Dennis Behm <[email protected]>

add buildIdentifier and releaseIdentifier

333c0f7

Signed-off-by: Dennis Behm <[email protected]>

Compute publishing parameters for packaging

2eea9b1

Signed-off-by: Dennis Behm <[email protected]>

fix duplicate variable usage

068cc8b

Signed-off-by: Dennis Behm <[email protected]>

introduce packageBuildIdentifier

fd398d2

Signed-off-by: Dennis Behm <[email protected]>

Refactored PackageBuildOutputs to return url

d09cdac

Signed-off-by: Dennis Behm <[email protected]>

reference PackagingScript

86a5b61

Signed-off-by: Dennis Behm <[email protected]>

document external dependencies

31a2439

Signed-off-by: Dennis Behm <[email protected]>

MOLLY and others added 4 commits April 8, 2025 16:58

Merge with Dennis's changes to enable calculation of Artifactory URL

1f98451

Finalize and add comments to computeReleaseVersion.sh

288170b

Add jenkins pipeline definition template that use Wazi Deploy

c12192d

Clean up value in pipelineBackend.config

71a10e6

monvora marked this pull request as draft April 11, 2025 13:14

monvora marked this pull request as ready for review April 11, 2025 13:15

dennis-behm mentioned this pull request Apr 14, 2025

Update pipeline templates to use updated package lifecycle #311

Open

2 tasks

Merge remote-tracking branch 'upstream/main' into feature/301-create-…

f53be77

…utility-scripts-to-compute-the-next-release-build-for-CBS

dennis-behm reviewed Apr 28, 2025

View reviewed changes

Monvorath Phongpaibul and others added 3 commits April 28, 2025 17:40

Revert back the file to the original commit

6c553a4

Separate the Jenkin template changes for another PR.

1848448

Revert file permissions changed back to original

8e3ee4a

dennis-behm reviewed Apr 29, 2025

View reviewed changes

Document computeReleaseVersion.sh script in the readme.md file and mi…

29e817a

…nor update to the computeReleaseVersion.sh script based on Dennis's feedback

dennis-behm reviewed Apr 29, 2025

View reviewed changes

Update based on the feedback recieved.

459c0b0

dennis-behm reviewed Apr 30, 2025

View reviewed changes

dennis-behm linked an issue May 2, 2025 that may be closed by this pull request

Create utility scripts to compute the next release build for CBS #301

Open

Update based on the PR comments

4c04c2b

dennis-behm reviewed May 6, 2025

View reviewed changes

Monvorath Phongpaibul added 4 commits May 7, 2025 10:37

Add instruction/example how to retrieve the version number by pipelin…

98381e1

…e archestrator.

Add instruction/example how to retrieve the version number by pipelin…

346886e

…e archestrator.

Add instruction/example how to retrieve the version number by pipelin…

e077634

…e archestrator.

Add instruction/example how to retrieve the version number by pipelin…

76c8b1e

…e archestrator.

dennis-behm reviewed May 7, 2025

View reviewed changes

Add instruction/example how to retrieve the version number by pipelin…

c22a823

…e archestrator.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/301 create utility scripts to compute the next release build for cbs #310

Feature/301 create utility scripts to compute the next release build for cbs #310

monvora commented Apr 11, 2025

dennis-behm left a comment

dennis-behm Apr 28, 2025

monvora Apr 29, 2025

dennis-behm left a comment

monvora commented Apr 29, 2025

dennis-behm left a comment

dennis-behm Apr 29, 2025

monvora Apr 30, 2025

dennis-behm Apr 29, 2025

monvora Apr 30, 2025

dennis-behm Apr 29, 2025

monvora Apr 29, 2025

dennis-behm Apr 30, 2025

monvora May 6, 2025

dennis-behm Apr 30, 2025

monvora May 6, 2025

dennis-behm left a comment

dennis-behm Apr 30, 2025

monvora May 6, 2025

dennis-behm Apr 30, 2025

monvora May 6, 2025

dennis-behm Apr 30, 2025

monvora Apr 30, 2025

dennis-behm Apr 30, 2025

monvora May 2, 2025 •

edited

Loading

dennis-behm May 2, 2025

dennis-behm May 6, 2025

dennis-behm May 7, 2025

monvora May 7, 2025

dennis-behm May 7, 2025

monvora May 7, 2025 •

edited

Loading

	[computeReleaseVersion.sh](computeReleaseVersion.sh) \| Pipeline Shell Script to compute the next release version based on the baseline version information stored in the [baselineReference.config](samples/baselineReference.config) file. \| [script details](#computeReleaseVersionsh)
	[computeReleaseVersion.sh](computeReleaseVersion.sh) \| Pipeline Shell Script to compute the next release version based on the baseline version information stored in the application's [baselineReference.config](samples/baselineReference.config) file. \| [script details](#computeReleaseVersionsh)

	ERRMSG=$PGM": [ERROR] Release type can only be Major, Minor or Patch. rc="$rc
	ERRMSG=$PGM": [ERROR] No valid release type found. Valid release types are 'major', 'minor' or 'patch'. rc="$rc

	ERRMSG=$PGM": [ERROR] Compute the next release version failed. Check Console for details. rc="$rc
	ERRMSG=$PGM": [ERROR] Compute the next release version failed. Check console for details. rc="$rc

		}

		```

Feature/301 create utility scripts to compute the next release build for cbs #310

Are you sure you want to change the base?

Feature/301 create utility scripts to compute the next release build for cbs #310

Conversation

monvora commented Apr 11, 2025

dennis-behm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dennis-behm left a comment

Choose a reason for hiding this comment

monvora commented Apr 29, 2025

dennis-behm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dennis-behm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monvora May 2, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monvora May 7, 2025 • edited Loading

Choose a reason for hiding this comment

monvora May 2, 2025 •

edited

Loading

monvora May 7, 2025 •

edited

Loading