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

Split plugin and site modules #595

Merged

Conversation

abelsromero
Copy link
Member

Thank you for opening a pull request and contributing to asciidoctor-maven-plugin!

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Documentation
  • Refactor
  • Build improvement
  • Other (please describe)

What is the goal of this pull request?
Splig the Maven Plugin and Doxia components in different modules following Maven practices.
Current Jar works as both because we are generating the appropiate metadata for both use cases, but it requires users to download dependencies they don't need.

Are there any alternative ways to implement this?
n/a

Are there any implications of this pull request? Anything a user must know?
Published artifacts change, from single jar org.asciidoctor:asciidoctor-maven-plugin we will have 3:

  • org.asciidoctor:asciidoctor-maven-plugin
  • org.asciidoctor:asciidoctor-doxia-module
  • org.asciidoctor:asciidoctor-maven-commons (shared dependency by both).

Is it related to an existing issue?

  • Yes
  • No

Closes #574

Finally, please add a corresponding entry to CHANGELOG.adoc

@abelsromero
Copy link
Member Author

abelsromero commented Aug 21, 2022

Right now the doxia module is calle asciidoctor-doxia-module, but it may change. Specially once we have multuple modules #571.

@abelsromero abelsromero force-pushed the issue-574-split-plugin-and-site-modules branch from bb54a92 to 3d3af7b Compare August 21, 2022 17:30
@abelsromero
Copy link
Member Author

IMPORTANT: For history reasons I am not changing the project repo yet. I have seen IntelliJ not liking that the parent module is "asciidoctor-maven-tools" and the folder is "asciidoctor-maven-plugin", and furthermore there's sub-module called "asciidoctor-maven-plugin" ... but can be fixed renaming the folder.

@abelsromero
Copy link
Member Author

Completed successfull deployment (just staging) on Maven Central with new structure, this will be the layout, the new artifacts all appear under org.asciidoctor. I personally don't want to make it more complicated with extra "maven" sub-levels and doing so also means changing the artifact coordinates.

image

@abelsromero abelsromero merged commit 4b0e609 into asciidoctor:main Aug 25, 2022
@abelsromero abelsromero deleted the issue-574-split-plugin-and-site-modules branch August 25, 2022 17:42
abelsromero added a commit that referenced this pull request Aug 25, 2022
* Create parent module: asciidoctor-maven-tools
* Create new dedicated modules: asciidoctor-maven-plugin, asciidoctor-doxia-module,
asciidoctor-maven-commons
* Remove unused gmaven-plugin eclipse condiguration
* Remove use of commons-lang3 for StringUtils.isBlank
* Remove use of deprecated constructor in AsciidoctorDoxiaParserModule
* Add 'asciidoc' as valid file extension in AsciidoctorDoxiaParserModule
* Update docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Split maven plugin and site module in 2 separated submodules
1 participant