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

[MPLUGINTESTING-93] Documentation for Plugin testing #597

Open
wants to merge 13 commits into
base: master
Choose a base branch
from

Conversation

aamotharald
Copy link

Added Docu on how to test with JUnit5.
Converted the Docu from apt to md .
This PR should only get merged once org.apache.maven.plugin-testing:maven-plugin-testing-harness:3.4.0 has been released as on 3.3.0 there is no JUnit5 testing support at all.

@slawekjaranowski slawekjaranowski self-requested a review December 17, 2024 10:41
@slawekjaranowski slawekjaranowski self-assigned this Dec 21, 2024
Copy link
Contributor

@Bukama Bukama left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the migration. Got some comments, you may want to consider.

P.S. I personally prefer to write only one sentence per line in a documentation as code file, but I don't know if maven has clear rules about this.

content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
@elharo elharo changed the title MPLUGINTESTING-93 Documentation for Plugin testing [MPLUGINTESTING-93] Documentation for Plugin testing Dec 23, 2024
@aamotharald
Copy link
Author

Thanks @slawekjaranowski @elharo and @Bukama for your review! I learned a lot and was able to address your review comments with (for me) sound solutions.

content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved

### Using PlexusTestCase

Mojo variables are injected by Guice (an open-source software framework for the Java platform), sometimes with a Codehaus Plexus (a collection of components used by Apache Maven) adapter to support the legacy `@Component` annotation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete "to support the legacy @Component annotation."

I've eliminated all of those

content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
@Bukama
Copy link
Contributor

Bukama commented Jan 6, 2025

Can't add anything to what @elharo has already mentioned.

content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved

### Using PlexusTestCase

Mojo variables are injected by Guice (an open-source software framework for the Java platform), sometimes with a Codehaus Plexus (a collection of components used by Apache Maven) adapter.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete "(an open-source software framework for the Java platform)" as it doesn't add much. Folks can Google it if they've never heard of it

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and might as wellm delete "(a collection of components used by Apache Maven)" too

content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
content/markdown/plugin-developers/plugin-testing.md Outdated Show resolved Hide resolved
@elharo elharo added the documentation Improvements or additions to documentation label Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants