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(build): add/apply autodoc plugin #2028

Conversation

paullatzelsperger
Copy link
Member

@paullatzelsperger paullatzelsperger commented Sep 29, 2022

What this PR changes/adds

Applies the autodoc plugin to the EDC code base.

Why it does that

metadata manifests should be auto-generated

Further notes

  • At this time we only have a 0.0.1-SNAPSHOT version available
  • The plugin, the annotation processor and the metamodel all use the same version, but I created three different variables, because their versioning might deviate in the future.
  • the plugin's name and group id looks wrong, but actually needs to be this way, otherwise publishing to OSSRH Snapshots and the Gradle Portal would not be possible
  • documentation will follow shortly, once the documentation-PR (docs: add documentation for autodoc GradlePlugins#12) of the plugin itself is merged, because it will link there.

Linked Issue(s)

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 added documentation Improvements or additions to documentation build Anything related to the CI/CD Pipeline on Github Actions labels Sep 29, 2022
@paullatzelsperger paullatzelsperger added this to the Milestone 7 milestone Sep 29, 2022
@paullatzelsperger paullatzelsperger temporarily deployed to Azure-dev September 29, 2022 08:57 Inactive
@paullatzelsperger paullatzelsperger marked this pull request as ready for review September 29, 2022 08:58
@codecov-commenter
Copy link

Codecov Report

Base: 63.85% // Head: 63.87% // Increases project coverage by +0.02% 🎉

Coverage data is based on head (ea2576c) compared to base (01f797b).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2028      +/-   ##
==========================================
+ Coverage   63.85%   63.87%   +0.02%     
==========================================
  Files         781      781              
  Lines       16505    16512       +7     
  Branches     1075     1076       +1     
==========================================
+ Hits        10539    10547       +8     
+ Misses       5519     5518       -1     
  Partials      447      447              
Impacted Files Coverage Δ
...econnector/spi/system/ServiceExtensionContext.java 0.00% <0.00%> (ø)
...ataspaceconnector/boot/system/ExtensionLoader.java 87.17% <0.00%> (+0.33%) ⬆️
...or/boot/system/DefaultServiceExtensionContext.java 88.37% <0.00%> (+1.52%) ⬆️
...taspaceconnector/junit/testfixtures/MockVault.java 28.57% <0.00%> (+28.57%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@paullatzelsperger paullatzelsperger temporarily deployed to Azure-dev September 29, 2022 11:28 Inactive
Copy link
Member

@ndr-brt ndr-brt left a comment

Choose a reason for hiding this comment

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

neat

@paullatzelsperger paullatzelsperger merged commit 358fcb2 into eclipse-edc:main Oct 3, 2022
@paullatzelsperger paullatzelsperger deleted the feature/apply_autodoc_plugin branch October 3, 2022 07:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Anything related to the CI/CD Pipeline on Github Actions documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants