Improve BOM/catalog generation #691
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
This commit enhances the possibilities when generating BOMs. Before this change, only Micronaut modules, which were published with a Gradle version catalog, were inlined into the generated BOM. With this change, a new option, `inlineRegularBOMs`, when set to `true`, will _also_ inline BOMs which are _not_ version catalogs. There are limitations though. For example, we cannot reuse versions which were defined in the BOMs, if any. Instead, all included dependencies will have an alias matching the artifact id, and a version property will be defined with the same name. For example, if an artifact id is `my-awesome-lib`, then an alias with the name `my-awsome-lib` will be created in the catalog, a version with the same name will be created in the catalog, and in the Maven BOM a property named `my.awesome.lib.version` will be added so that users can override these easily. In addition, it's now possible to include/exclude from inlining, on a per included catalog/BOM basis.
alvarosanchez
approved these changes
May 30, 2024
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.
This commit enhances the possibilities when generating BOMs. Before this change, only Micronaut modules, which were published with a Gradle version catalog, were inlined into the generated BOM. With this change, a new option,
inlineRegularBOMs, when set totrue, will also inline BOMs which are not version catalogs.There are limitations though. For example, we cannot reuse versions which were defined in the BOMs, if any. Instead, all included dependencies will have an alias matching the artifact id, and a version property will be defined with the same name. For example, if an artifact id is
my-awesome-lib, then an alias with the namemy-awsome-libwill be created in the catalog, a version with the same name will be created in the catalog, and in the Maven BOM a property namedmy.awesome.lib.versionwill be added so that users can override these easily.In addition, it's now possible to include/exclude from inlining, on a per included catalog/BOM basis.