[MPLUGINTESTING-93] Prepare documentation / examples for JUnit 5 and Maven 3/4

[jira-importer]

Slawomir Jaranowski opened MPLUGINTESTING-93 and commented

We have implementation but documentation is lack ...

---

Attachments:

• image-2024-12-13-17-28-51-423.png (89.47 kB)

Remote Links:

• GitHub Pull Request #49
  
• GitHub Pull Request #50
  
• GitHub Pull Request #597
  

[jira-importer]

Harald Aamot commented

Hi sjaranowski ,
I would be happy/willing to contribute Documentation and samples if you can offer a release of version 3.4.0 in turn. Or are there any other blockers for MPLUGINTESTING-72 ?

[jira-importer]

Slawomir Jaranowski commented

I would be happy/willing to contribute Documentation and samples if you can offer a release of version 3.4.0 in turn. Or are there any other blockers for MPLUGINTESTING-72 ?

Ok we have a deal :)

We have branches master and maven-plugin-testing-3.x we need check if examples will be the same for both if not we need updates in both.

[jira-importer]

Harald Aamot commented

Hi sjaranowski ,
I'll try to maintain the examples for for the 3.x and the master branch..
I don't expect a discrepancy there as only the maven version differs, the testing fram,work stays the same - JUnit 5 ..
I won't commit any timelines but have an ineterst to get this in :)

[jira-importer]

Harald Aamot commented

Hi sjaranowski ,
can you please point me to the repo in which this documentation is written?
https://maven.apache.org/plugin-developers/plugin-testing.html
I can adopt the documentation
https://maven.apache.org/plugin-testing/maven-plugin-testing-harness/
by changing documents in the https://github.com/apache/maven-plugin-testing/ repo, but I cannot find the source for the other page..

[jira-importer]

Slawomir Jaranowski commented

aamotharald - examples

https://github.com/apache/maven-site/blob/master/content/apt/plugin-developers/plugin-testing.apt
https://github.com/apache/maven-plugin-testing/blob/maven-plugin-testing-4.0.0-beta-2/maven-plugin-testing-harness/src/site/apt/index.apt

 

There is an edit icon: !image-2024-12-13-17-28-51-423.png!

If you wich you can rewrite it to markdown.

[jira-importer]

Harald Aamot commented

Thanks a lot sjaranowski ,

I'll use doxia (MNGSITE-507) to convert to markdown. I guess removing the apt file from the apt folder and putting in the markdown file into the markdown folder will do the trick..

[jira-importer]

Harald Aamot commented

Hi sjaranowski ,
sorry to bother again..
When adding documentation for maven-plugin-testing..
in the repo we have the master and the maven-plugin-testing-3.x branch.
I guess the documentation only gets published via the master branch pipeline run?
I plan to make a Docu PR against the master branch which thenb could get merged after/witjh the 3.4.0 release?

Let me know if this approach fits.
My existing PR #49 that marks JUnit4 tests as deprecated in the 3.4.0 release (in the 4.x.x/master release line JUnit4 support is anyhow removed..) will then be decoupled from the pure documentation related PR.