Refactoring loading build properties #402
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Dennis Behm <[email protected]>
Signed-off-by: Dennis Behm <[email protected]>
Signed-off-by: Dennis Behm <[email protected]>
…lication_conf_dir_configuration
Signed-off-by: Dennis Behm <[email protected]>
Signed-off-by: Dennis Behm <[email protected]>
Signed-off-by: Dennis Behm <[email protected]>
Signed-off-by: Dennis Behm <[email protected]>
Signed-off-by: Dennis Behm <[email protected]>
M-DLB
reviewed
Aug 31, 2023
There was a problem hiding this comment.
Thanks @dennis-behm !
There are some typos too, in the HOWTOS.md mainly, if you can have a look, please.
samples/application-conf/README.md
Outdated
| @@ -1,12 +1,12 @@ | |||
| # Application Configuration | |||
| This folder contains application specific configuration properties used by the zAppBuild Groovy build and utility scripts. It is intended to be copied as a high level folder in the application repository or main application repository if the application source files are distributed across multiple repositories. Once copied to the application repository, users should review the default property files and modify any values as needed. | |||
|
|
|||
| At the beginning of the build, the `application-conf/application.properties` file will automatically be loaded into the [DBB BuildProperties class](https://www.ibm.com/support/knowledgecenter/SS6T76_1.0.4/scriptorg.html#build-properties-class). Use the `applicationPropFiles` property (see table below) to load additional application property files. | |||
| At the beginning of the build, the `application-conf/application.properties` file will automatically be loaded based on the definition of `applicationConfDir` [property](../../build-conf/build.properties) into the [DBB BuildProperties class](https://www.ibm.com/docs/en/dbb/2.0?topic=apis-build-properties#build-properties-class). Use the `applicationPropFiles` property (see table below) to load additional application property files. | |||
There was a problem hiding this comment.
Maybe we can say that it's "by default, zAppBuild is configured to look at application-conf/application.properties but this can be changed. Something like:
At the beginning of the build, the application.properties file will automatically be searched and loaded if it exists into the DBB BuildProperties class. The application.properties file is by default searched in the application-conf folder of the application, but this can be modified through the applicationConfDir property.
docs/HOWTOS.md
Outdated
| zAppBuild provides 3 properties `buildPropFiles`, `applicationDefaultPropFiles` and the `applicationPropFiles` that each reference a list of properties files, which contain important configuration parameters to configure the build process. The referenced properties files are loaded in the below order of precedence: | ||
|
|
||
| * `buildPropFiles` managed in [build-conf/build.properties](../build-conf/build.properties) references properties files in the [build-conf](../build-conf/) directory for core zAppBuild settings for the language scripts such as system datasets, naming conventions of build datasets, dataset characteristics and various core properties of the build framework as well, like the reporting features. |
There was a problem hiding this comment.
Can we say that these properties are "enterprise-level" properties for the build framework (i.e. low-level properties)? Could you add something like that, please?
docs/HOWTOS.md
Outdated
|
|
||
| * `buildPropFiles` managed in [build-conf/build.properties](../build-conf/build.properties) references properties files in the [build-conf](../build-conf/) directory for core zAppBuild settings for the language scripts such as system datasets, naming conventions of build datasets, dataset characteristics and various core properties of the build framework as well, like the reporting features. | ||
| * The property `applicationDefaultPropFiles` is managed in [build-conf/build.properties](../build-conf/build.properties) as well and allows the user to define default application (and also language script specific related) properties, that are centrally managed. |
There was a problem hiding this comment.
To make it a bit clearer, could you say that these properties are "enterprise-level" properties shared across all applications, and provide examples (I don't know, maybe default compile options?) ?
There was a problem hiding this comment.
Added 97ff to explain the difference between enterprise-level/central and local
docs/HOWTOS.md
Outdated
| * `buildPropFiles` managed in [build-conf/build.properties](../build-conf/build.properties) references properties files in the [build-conf](../build-conf/) directory for core zAppBuild settings for the language scripts such as system datasets, naming conventions of build datasets, dataset characteristics and various core properties of the build framework as well, like the reporting features. | ||
| * The property `applicationDefaultPropFiles` is managed in [build-conf/build.properties](../build-conf/build.properties) as well and allows the user to define default application (and also language script specific related) properties, that are centrally managed. | ||
| * `applicationPropFiles` is referencing properties files providing application specific settings. This property is managed in the applications' `application-conf/application.properties` file which is by default located in the applications' [application-conf](../samples/application-conf/) folder. These settings define compiler and link options, deploy types, script mappings and search path configurations for the DBB dependency and impact analysis. A sample is provided in [application-conf](../samples/application-conf/). The default location for zAppBuild to locate the `application.properties` file within the `application-conf` directory is defined via the `applicationConfDir` setting that is managed in [build-conf/build.properties](../build-conf/build.properties). The default mandates am `application-conf` folder including the `application.properties` file to be present in the applications' git repository. |
There was a problem hiding this comment.
Same comment - Can we say these are "application-level" properties and that they override the default properties defined through applicationDefaultPropFiles?
Signed-off-by: Dennis Behm <[email protected]>
Signed-off-by: M-DLB <[email protected]>
Signed-off-by: Dennis Behm <[email protected]>
https://github.com/dennis-behm/dbb-zappbuild into 399_refactor_application_conf_dir_configuration
M-DLB
approved these changes
Sep 1, 2023
Merged
ijmitch
pushed a commit
to ijmitch/dbb-zappbuild
that referenced
this pull request
Sep 12, 2023
Reorganization of the application-level properties into centrally-managed properties files Signed-off-by: Dennis Behm <[email protected]> Co-authored-by: Mathieu Dalbin <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
zAppBuild is leveraging 3 properties
buildPropFiles,applicationDefaultPropFilesandapplicationPropFiles, that each define a list of additional properties to load to configure zAppBuild.The PR is proposing the following changes:
applicationConfRootDirproperty with a configuration parameter to define where zAppBuild is locating theapplication-conffolder which includes theapplication.propertiesfile.application-confdirectory optional, when zAppBuild is configured via the central configuration parametersbuildPropFilesandapplicationDefaultPropFilesproperties. (See HOWTO recipe).