feat: add autodocBom task to generate Autodoc manifests for BOMs #282
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
ndr-brt
reviewed
Oct 17, 2024
| @TaskAction | ||
| public void mergeManifests() { | ||
| if (!getProject().getName().endsWith("-bom")) { | ||
| getLogger().warn("Project name does not end with '-bom'. Is this really a BOM module?"); |
There was a problem hiding this comment.
maybe this functionality shouldn't be limited to bom modules, e.g. an EDC distribution (like Tractus-X) could be interested in generating a comprehensive autodoc out of a set of dependencies.
the warning wouldn't be needed then
There was a problem hiding this comment.
this would require a bit of refactoring, because then, the autodocBom task would not depend on the resolveManifest task anymore, but on either resolveManifest or downloadManifests.
alternatively, resolveManifest and downloadManifest could be merged into one, and artifact resolution (of the manifest file) happens dynamically based on its URI.
Definitely worth exploring, though in a different PR, IMO.
ndr-brt
approved these changes
Oct 17, 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.
What this PR changes/adds
Enables the autodoc functionality for BOM modules. To do that, simply invoke:
or
then, after locally resolving all autodoc manifests of referenced modules, the
autodocBomtask puts the merged manifest inbuild/edc.jsonWhy it does that
the normal
autodoctask doesn't work on BOM modules because they typically don't contain code, thus the compiler isn't engaged, andautodocdoesn't run.Further notes
autodocBomtask is invoked on a project where the name doesn't end with"-bom", a warning is loggedresolveManifestanddownloadManifesttasks don't generate empty files anymore (nullinstead ofInputStream.nullStream())Linked Issue(s)
Closes # <-- insert Issue number if one exists
Please be sure to take a look at the contributing guidelines and our etiquette for pull requests.