Modularise the plugin

[andrzejj0]

Another (mainteinance) idea: modularise the plugin: at least a separate module for the API, etc.

[slawekjaranowski]

Idea is known ... topic not easy

https://groups.google.com/g/mojohaus-dev/c/hRltMfTmB4o

We also have some of proposition in PR #619

[slawekjaranowski]

The most important is that we will break a links to documentation site.

Site is referenced from many place ... we need some redirection from old url to new one.

There is many useful hints https://gist.github.com/domenic/1f286d415559b56d725bee51a62c24a7

[andrzejj0]

I've noticed that it's not an easy job. Everything is interconnected.

[andrzejj0]

I don't get why you want to move the repository though. I'll create a draft PR so that you can have a look at my work so far, albeit not done yet.

[andrzejj0]

The most important is that we will break a links to documentation site.

I've updated the links, but now I'm actually thinking of maybe changing the outputDirectory of maven-plugin-plugin:report so that all mojo documentation is generated in the same folder?

EDIT: No, that would mess things up.

[slawekjaranowski]

Proposition for first step

first modules

• parent - with gav org.codehaus.mojo.versions:versions
• versions-maven-plugin - org.codehaus.mojo:versions-maven-plugin - almost everything as is
• model - org.codehaus.mojo.versions:model - model for main plugin - rules
• model-report - org.codehaus.mojo.versions:model-report - model for reporting

assumptions

• plugin will has original groupId org.codehaus.mojo
• all new modules will have new groupId org.codehaus.mojo.versions - we will have everything for versions project under separate groupId in one place
• current documentations is for plugin - so should be in versions-m-p module as is

rename git repository to versions

Links like https://www.mojohaus.org/versions-maven-plugin/... should be redirect to https://www.mojohaus.org/versions/versions-maven-plugin/...

I hope it can be achieved by creating simple html files in https://github.com/mojohaus/mojohaus.github.io with redirects
AFS analytics can help to detect missing items

https://analytics.apache.org/index.php?module=CoreHome&action=index&date=yesterday&period=day&idSite=18#?idSite=18&period=day&date=yesterday&category=General_Actions&subcategory=Events_Events

Next steps

Introduce new module versions-report-maven-plugin

Reporting needs many stuff on dependencies for doxia and so on - those are not needed for standard plugin

Probably shared/common module will be needed for commons items for main and reporting plugin

Public api module

Public api should only contains interfaces / enums which allow to crate extensions for plugin
We need documentation and examples how to write extensions

[andrzejj0]

If we're changing the packages, shouldn't it be org.mojohaus?

[andrzejj0]

current documentations is for plugin - so should be in versions-m-p module as is

Well, that will make the generated root site notably empty.

Unless you want to redirect the output of the site plugin to the root module's target, but I wouldn't recommend that.

[slawekjaranowski]

Root site will contains list of modules and simple description like in https://maven.apache.org/surefire/index.html

[slawekjaranowski]

First step done,
Next should be in next PR.