feat: download transitive autodoc manifests #167
Merged
+244
−8
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
This PR adds a gradle task
downloadManifests
, that downloads the-manifest.json
from Maven for everyorg.eclipse.edc
dependency.Downstream projects, such as Tractus-X, that have dependencies onto EDC modules, can now merge their autodoc manifests with those coming from EDC.
Usually, the sequence is this:
which will produce a Markdown file containing documentation about the code base plus any transitive EDC dependencies.
Alternatively, they can be run together:
Why it does that
easily create documentation
Further notes
--no-parallel
optionLinked Issue(s)
Closes # <-- insert Issue number if one exists