You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Read and agree to the [Developer Certificate of Origin](https://github.com/IBM/dbb-zappbuild/blob/development/DCO1.1.txt) document.
3
-
* Fork and Create a Pull Request
4
-
* Fork the dbb-zappbuild repo, create a new topic branch from development and apply your changes there. Create a Pull Request from your topic branch against the dbb-zappbuild development branch.
4
+
* Fork this repository and Create a Pull Request
5
+
* Fork the dbb-zappbuild repo, create a new topic branch from `main` and apply your changes there. Create a Pull Request from your topic branch against the dbb-zappbuild `main` branch.
5
6
* Limit each Pull Request to one enhancement or bug fix. Don't bundle multiple enhancements/changes (e.g. a new enhancement and a fix to an existing sample) into a single Pull Request - create one PR for the new enhancement, and a separate PR for the fix.
6
-
* For complex changes, try to squash your changes into a single commit. Don't create a PR consisting of 20 commits that show your work in progress. Before you create the PR, squash your changes into a single commit.
7
+
* For complex changes, try to squash your changes into a single commit. Don't worry if you have missed that, the reviewer can squash the commits when merging your PR.
7
8
* Send an email to drbruce@us.ibm.com with a link to the Pull Request and the following statement:
8
-
```
9
-
DCO 1.1 signed-off-by: Random J Developer random@developer.org.
10
-
```
9
+
10
+
```
11
+
DCO 1.1 signed-off-by: Random J Developer random@developer.org.
12
+
```
13
+
11
14
* The contribution will be reviewed by a member of the IBM Dependency Based Build development team.
Copy file name to clipboardExpand all lines: README.md
+15-4Lines changed: 15 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,30 @@
2
2
3
3
zAppBuild is a generic build solution for building z/OS applications using Apache Groovy build scripts and IBM Dependency Based Build (DBB) APIs.
4
4
5
+
IBM Dependency Based Build version 3.0 has introduced the zBuilder build framework - allowing your build configuration to be defined in YAML. This is an alternative build approach to zAppBuild. For further information see [Getting Started Guide for zBuilder](https://www.ibm.com/docs/en/adffz/dbb/3.0.0?topic=zbuilder-getting-started).
6
+
5
7
## Resources
6
8
7
9
*[IBM Dependency Based Build Product Page](https://www.ibm.com/products/dependency-based-build)
*[IBM Development and Pipeline Community](https://community.ibm.com/community/user/ibmz-and-linuxone/groups/topic-home?CommunityKey=f461c55d-159c-4a94-b708-9f7fe11d972b)
13
14
14
15
## Contributing
15
16
16
17
For instructions on how to contribute enhancements and bug fixes to zAppBuild, please read the [Contributions Guidelines](CONTRIBUTIONS.md).
17
18
19
+
## zAppBuild releases
20
+
21
+
zAppBuild publishes [releases](https://github.com/IBM/dbb-zappbuild/releases) with a New & Noteworthy summary via Github's release capability.
22
+
23
+
Contributions are reviewed and then merged into branch `main`. The maintainers of the repository will create a [release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) when the contents qualifies for a new release and the state of the repository passed the [zAppBuild test framework](test/).
24
+
25
+
The [version.properties](version.properties) file contains the recent version number, and is displayed when running zAppBuild with `--verbose` output option.
26
+
27
+
You'll find a [discussion](https://github.com/IBM/dbb-zappbuild/discussions) page for each zAppBuild release.
28
+
18
29
## How zAppBuild works
19
30
20
31
The zAppBuild repository is intended to be cloned to a single location on Unix Systems Services (USS) and used to build all of your z/OS applications. Global configuration properties are configured in the properties files in the [build-conf](build-conf/) directory. Specifying application-level properties is done by simply copying the supplied `application-conf` folder (located in the [samples folder](samples)) to the application source repository you want to build and then verify/update the contained default configuration property values to ensure they meet the build requirements of your application. See the included [MortgageApplication](samples/MortgageApplication) sample for an example of an application that has been modified to be built by zAppBuild.
Copy file name to clipboardExpand all lines: docs/GettingStarted.md
+8-13Lines changed: 8 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ Here are the steps to make the zAppBuild repository available in a central repos
22
22
1. In the terminal, navigate to the folder where you would like to clone the repository.
23
23
2. Retrieve the Git repository URL or SSH path from IBM's public [zAppBuild repository](https://github.com/IBM/dbb-zappbuild):
24
24
25
-
25
+
26
26
3. In your terminal, enter the command for cloning the repository. (The following command uses the Git repository URL, but the SSH path can also be used if you have SSH keys set up.):
27
27
28
28
```shell
@@ -31,7 +31,7 @@ Here are the steps to make the zAppBuild repository available in a central repos
31
31
32
32
- Example Git clone command with output in a terminal:
33
33
34
-
34
+
35
35
3. Follow the instructions of your Git provider to push the contents of your newly-cloned local repository (from Step 2) to the central repository on your Git provider (created in Step 1). (Note: Exact instructions may vary from Git provider to Git provider.)
36
36
1. Within the terminal session, execute the following commands to push an existing Git repository:
37
37
- Replace `<existing_repo>` with the path to your newly-cloned local repository.
@@ -48,7 +48,7 @@ Here are the steps to make the zAppBuild repository available in a central repos
48
48
2. On the Git provider's webpage for your new central repository in the browser, you will find that the repository is now populated with all of zAppBuild's files and history, just like on IBM's public [zAppBuild](https://github.com/IBM/dbb-zappbuild) repository.
49
49
- The following screenshot shows an example of a populated central zAppBuild repository with GitLab as the Git provider:
50
50
51
-
51
+
52
52
53
53
## Updating your customized version of zAppBuild
54
54
@@ -58,7 +58,7 @@ Once you have a clone of zAppBuild in your Git provider, you can customize the p
58
58
2. Add a new Git remote definition to connect to IBM's official public zAppBuild GitHub repository. (Note: This step requires internet connectivity.)
59
59
1. First, list the remotes by issuing `git remote -v`:
60
60
61
-
61
+
62
62
63
63
- For more on Git remotes, see the [git-remote](https://git-scm.com/docs/git-remote) documentation.
64
64
@@ -70,36 +70,31 @@ Once you have a clone of zAppBuild in your Git provider, you can customize the p
70
70
71
71
3. Verify that the new remote is available by issuing the command to list the remotes again: `git remote -v`:
72
72
73
-
73
+
74
74
75
75
4. Fetch the latest information from the official repository, by executing a Git fetch for the official dbb-zappubuild repository:
76
76
77
77
```shell
78
78
git fetch zappbuild-official
79
79
```
80
80
81
-
81
+
82
82
83
83
5. Make sure that your feature branch is checked out, before attempting to merge the changes from zappbuild-official. To merge the changes run into your branch `update-zappbuild`, run the following command:
84
84
85
85
```shell
86
86
git merge zappbuild-official/main
87
87
```
88
88
89
-
89
+
90
90
91
91
Potentially, you face merge conflicts. In the above case, the merge processor could not automatically resolve the `utilities/ImpactUtilities.groovy`.
92
92
93
93
Run the command`git status` to see which files changed:
94
94
95
-
96
-
95
+
97
96
6. Open the unmerged files and resolve them manually. Either use the terminal, or an IDE for this task.
98
97
99
-
:::tip
100
-
101
98
The Git integration in many modern IDEs (for example, VS Code) is able to provide a side-by-side comparison highlighting the diff between your feature branch and the incoming changes from the merge attempt (in this case, from `zappbuild-official`). This can help make manual resolution of any merge conflicts much easier.
102
99
103
-
:::
104
-
105
100
7. Commit the changes and verify them with a sample application before committing it (or opening a pull request to commit it) to your main branch that is used for all your production DBB builds.
Copy file name to clipboardExpand all lines: docs/README.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,7 @@ This folder contains supplemental documentation to help explain the implementati
4
4
5
5
|File|Description|
6
6
|-|-|
7
+
|[Getting Started](GettingStarted.md)|Getting started guidance to maintain zAppBuild in a customer's Git provider|
7
8
|[Build Management](BUILD.md)|Documentation of the main and start build script `build.groovy`, reference of the command line options of the build script and documentation of the build scenarios supported by zAppBuild |
8
9
|[Build Property Management](FilePropertyManagement.md)|Documentation on managing default and overriding build properties for specific application files|
9
10
|[Reporting Capabilities](REPORTS.md)|Documentation of zAppBuild reporting capabilities like reporting external impacted file and reporting of concurrent changes|
0 commit comments