Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: download transitive autodoc manifests #167

Conversation

paullatzelsperger
Copy link
Member

@paullatzelsperger paullatzelsperger commented Aug 1, 2023

What this PR changes/adds

This PR adds a gradle task downloadManifests, that downloads the -manifest.json from Maven for every org.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:

./gradlew autodoc
./gradlew downloadManifests
./gradlew mergeManifests
./gradlew doc2md

which will produce a Markdown file containing documentation about the code base plus any transitive EDC dependencies.

Alternatively, they can be run together:

./gradlew autodoc downloadManifests mergeManifests doc2md --no-parallel

Why it does that

easily create documentation

Further notes

  • these gradle tasks run async and potentially multithreaded, so they really should be called in separate gradle invocations or with the --no-parallel option

Linked Issue(s)

Closes # <-- insert Issue number if one exists

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@paullatzelsperger paullatzelsperger added the enhancement New feature or request label Aug 1, 2023
Copy link
Contributor

@wolf4ood wolf4ood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@paullatzelsperger paullatzelsperger merged commit 416805a into eclipse-edc:main Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants