Include groovydoc plugin in pom.xml to enable report generation #59
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Steffengreiner
changed the title
jenniferboedker
approved these changes
Feb 8, 2022
wow-such-code
added a commit
that referenced
this pull request
May 6, 2022
* Sync with hotfix 1.9.2 (#69) * Hotfix 1.9.1 (#66) * Fix RST syntax error * Remove orphaned print statement * Update CL * Bump version 1.9.1 -> 1.9.2 Co-authored-by: Steffengreiner <[email protected]> * Update maxquant file parser (#74) The summary file is now searched within the summary folder * Remove qube files and Bump version to 1.11.0-SNAPSHOT * Bump conf.py to current version * Bump version to 1.11.0-SNAPSHOT * Include groovydoc plugin in report generation (#59) * Feature/update nanopore (#91) * increase some versions, fix testing env * add tests for alternative nanopore structure * Add worflow triggers (#93) * Add triggers * Reorder git commands * Use master as base, not main * parser * update workflows (#94) * Set version to 1.10.6 * update pom * Fix project setup (#96) * add possibility of some metadata values being empty * comments * extract method to validate a single schema Co-authored-by: Sven F <[email protected]> Co-authored-by: JohnnyQ5 <[email protected]> Co-authored-by: Steffengreiner <[email protected]> Co-authored-by: Sven F <[email protected]> * Feature/update nanopore (#97) * increase some versions, fix testing env * add tests for alternative nanopore structure * Add worflow triggers (#93) * Add triggers * Reorder git commands * Use master as base, not main * parser * update workflows (#94) * Set version to 1.10.6 * update pom * Fix project setup (#96) * add possibility of some metadata values being empty * comments * extract method to validate a single schema * use data-model-lib release Co-authored-by: Sven F <[email protected]> Co-authored-by: JohnnyQ5 <[email protected]> Co-authored-by: Steffengreiner <[email protected]> Co-authored-by: Sven F <[email protected]> * Update CHANGELOG.rst Co-authored-by: Tobias Koch <[email protected]> Co-authored-by: Sven F <[email protected]> Co-authored-by: Steffengreiner <[email protected]> Co-authored-by: jnnfr <[email protected]> Co-authored-by: JohnnyQ5 <[email protected]> Co-authored-by: Sven F <[email protected]> Co-authored-by: Tobias Koch <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of changes
This plugin enables the groovydoc maven plugin to function properly by including it in the report section of the pom.xml.
This is necessary to include the linkage to the generated groovydocs in project overview page.
Additional context
This can be easily tested by running
mvn siteand checking if there is a project reports section in the generatedindex.htmlfile in the target/site/ directory. (Open it in your favorite browser to see the generated html document)Without the plugin addition to the
pom.xmltheindex.htmlwill lack a dedicated project report sectionWith the plugin addition to the
pom.xmltheindex.htmlwill include the project reports section: