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: autodoc error on misplaced @Setting annotations #228

Merged
merged 2 commits into from
Mar 19, 2024

Conversation

ndr-brt
Copy link
Member

@ndr-brt ndr-brt commented Mar 18, 2024

What this PR changes/adds

Make autodoc fail on misplaced @Setting annotations.

Why it does that

Improve autodoc output.

Further notes

List other areas of code that have changed but are not necessarily linked to the main feature. This could be method
signature changes, package declarations, bugs that were encountered and were fixed inline, etc.

Linked Issue(s)

Closes #227

Please be sure to take a look at the contributing guidelines and our etiquette for pull requests.

@ndr-brt ndr-brt added the enhancement New feature or request label Mar 18, 2024
Copy link

github-actions bot commented Mar 18, 2024

Test Results

48 tests   - 8   48 ✅  - 8   16s ⏱️ -1s
20 suites +2    0 💤 ±0 
20 files   +2    0 ❌ ±0 

Results for commit b092334. ± Comparison against base commit 5138526.

This pull request removes 22 and adds 14 tests. Note that renamed tests count towards both.
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorExtensionTest ‑ [1] -Aedc.version=1.2.3, -Aedc.id=, -Aedc.outputDir=some/dir
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorExtensionTest ‑ [1] -Aedc.version=1.2.3, -Aedc.id=someid, -Aedc.outputDir=build/some/dir
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorExtensionTest ‑ [2] -Aedc.version=1.2.3, -Aedc.id=someid, null
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorExtensionTest ‑ [2] -Aedc.version=1.2.3, null, -Aedc.outputDir=some/dir
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorExtensionTest ‑ [3] -Aedc.version=, -Aedc.id=someid, -Aedc.outputDir=some/dir
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorExtensionTest ‑ [3] -Aedc.version=1.2.3, -Aedc.id=someid, -Aedc.outputDir=
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorExtensionTest ‑ [4] null, -Aedc.id=someid, -Aedc.outputDir=some/dir
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorExtensionTest ‑ verifyManifestContainsCorrectElements()
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorExtensionTest ‑ verifyManifestContainsCorrectSettingsWithContext()
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorExtensionTest ‑ verifyManifestContainsExtension()
…
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorTest ‑ shouldFail_whenSettingIsDefinedInClassNotExtension()
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorTest$CompilerArgs ‑ [1] -Aedc.version=1.2.3, -Aedc.id=, -Aedc.outputDir=some/dir
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorTest$CompilerArgs ‑ [1] -Aedc.version=1.2.3, -Aedc.id=someid, -Aedc.outputDir=build/some/dir
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorTest$CompilerArgs ‑ [2] -Aedc.version=1.2.3, -Aedc.id=someid, null
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorTest$CompilerArgs ‑ [2] -Aedc.version=1.2.3, null, -Aedc.outputDir=some/dir
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorTest$CompilerArgs ‑ [3] -Aedc.version=, -Aedc.id=someid, -Aedc.outputDir=some/dir
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorTest$CompilerArgs ‑ [3] -Aedc.version=1.2.3, -Aedc.id=someid, -Aedc.outputDir=
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorTest$CompilerArgs ‑ [4] null, -Aedc.id=someid, -Aedc.outputDir=some/dir
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorTest$CompilerArgs ‑ shouldCreateManifestFile_tempDir()
org.eclipse.edc.plugins.autodoc.core.processor.EdcModuleProcessorTest$CompilerArgs ‑ shouldOverrideOutputFolder()
…

♻️ This comment has been updated with latest results.

@ndr-brt ndr-brt changed the title feat: print warning on misplaced @Setting annotations feat: autodoc error on misplaced @Setting annotations Mar 19, 2024
@ndr-brt ndr-brt merged commit 46a48d0 into main Mar 19, 2024
20 of 21 checks passed
@ndr-brt ndr-brt deleted the 227-autodoc-setting-warning branch March 19, 2024 08:36
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.

print warning when @Setting is not defined into a ServiceExtension implementation
2 participants