Skip to content

Conversation

@paullatzelsperger
Copy link
Member

@paullatzelsperger paullatzelsperger commented Sep 23, 2022

What this PR changes/adds

This PR implements a Gradle plugin that does two things:

  • adds an annotationProcessor dependency on the autodoc-processor module to the Gradle project. Whenever the compileJava task is executed, the manifest gets generated.

  • registers a task named autodoc, that does nothing except express a dependency onto the compileJava task. That way, the manifest can get regenerated by calling ./gradlew autodoc

Why it does that

to have the autodoc plugin readily available as build script dependency

Further notes

  • The Maven coordinates of the processor module is currently hard-coded. At least the version should be resolved dynamically.
  • the compiler args are resolved automatically. Especially the output location is not yet configurable. That should be fixed.
  • More tasks (such as printModuleConfig) can be added later

Note to reviewers: lets use this draft as basis for an early discussion. Polishing (where needed) comes later :)

Checklist

  • added appropriate tests?
  • performed checkstyle check locally?
  • added/updated copyright headers?
  • documented public classes/methods?
  • added/updated relevant documentation?
  • assigned appropriate label? (exclude from changelog with label no-changelog)
  • formatted title correctly? (take a look at the CONTRIBUTING and styleguide for details)

@paullatzelsperger paullatzelsperger marked this pull request as ready for review September 26, 2022 14:35
@paullatzelsperger paullatzelsperger force-pushed the feature/implement_autodoc_plugin branch from 9040796 to dc533dd Compare September 26, 2022 14:35
@paullatzelsperger paullatzelsperger force-pushed the feature/implement_autodoc_plugin branch from dc533dd to 70a9f63 Compare September 27, 2022 12:19
@paullatzelsperger paullatzelsperger force-pushed the feature/implement_autodoc_plugin branch from 6acbbfa to b20d7c4 Compare September 27, 2022 13:00
@paullatzelsperger paullatzelsperger merged commit 9e534e8 into eclipse-edc:main Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants