Google Git
Sign in
apache / maven-surefire / f6bc398c4d5bc352967434ec6d0e7facccec7afe
commitf6bc398c4d5bc352967434ec6d0e7facccec7afe[log] [tgz]
authorSimonBaars <simon.mailadres@gmail.com>Fri Oct 28 11:56:10 2022 +0200
committerMaarten Mulders <mthmulders@apache.org>Fri Oct 28 15:18:27 2022 +0200
tree50641bb0746e7e3ffb57cf6c6c06261519ebfdd0
parentc305fc867a8160bf86c1e37713e1258ab6fb68e3 [diff]
[SUREFIRE-2122] Document development setup for IntelliJ

Closes #573.
1 file changed
tree: 50641bb0746e7e3ffb57cf6c6c06261519ebfdd0
  1. .github/
  2. maven-failsafe-plugin/
  3. maven-surefire-common/
  4. maven-surefire-plugin/
  5. maven-surefire-report-plugin/
  6. src/
  7. surefire-api/
  8. surefire-booter/
  9. surefire-extensions-api/
  10. surefire-extensions-spi/
  11. surefire-grouper/
  12. surefire-its/
  13. surefire-logger-api/
  14. surefire-providers/
  15. surefire-report-parser/
  16. surefire-shadefire/
  17. surefire-shared-utils/
  18. .asf.yaml
  19. .editorconfig
  20. .gitattributes
  21. .gitignore
  22. CONTRIBUTING.md
  23. deploySite.sh
  24. Jenkinsfile
  25. pom.xml
  26. README.md
README.md

Contributing to Apache Maven Surefire

ASF Jira Maven Central Apache License, Version 2.0, January 2004

CI Jenkins Status Jenkins tests Jenkins JaCoCo

Verify

The Maven Community

slack forks

Project Documentation

Maven 3.0 Plugin API

Usage of maven-surefire-plugin, maven-failsafe-plugin, maven-surefire-report-plugin

Development Information

Build the Surefire project using Maven 3.2.5+ and JDK 1.8+.

  • In order to run tests for a release check during the Vote, the following memory requirements are needed:

    On Linux/Unix:

    export MAVEN_OPTS="-server -Xmx512m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=384m -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+TieredCompilation -XX:TieredStopAtLevel=1 -XX:SoftRefLRUPolicyMSPerMB=50 -Djava.awt.headless=true"

    On Windows:

    set MAVEN_OPTS="-server -Xmx256m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=384m -XX:+UseG1GC -XX:+UseStringDeduplication -XX:+TieredCompilation -XX:TieredStopAtLevel=1 -XX:SoftRefLRUPolicyMSPerMB=50 -Djava.awt.headless=true"

  • In order to build and run the tests:

    mvn install site site:stage -P reporting,run-its

  • To set up the project in Eclipse IDE or IntelliJ IDEA, please follow these steps:

    • Build module surefire-shared-utils with profile ide-development and install it into the local maven repository using this Maven command:

      mvn install -P ide-development -f surefire-shared-utils/pom.xml

    • Build module surefire-grouper in order to generate and compile sources into target/generated-sources/javacc using this Maven command:

      mvn compile -f surefire-grouper/pom.xml

    • In Eclipse, select File > Import ... > Maven Project

      • Select all projects (poms) except surefire-shared-utils, enter profile ide-development in Advanced -> Profiles
      • Check module surefire-grouper has source folder target/generated-sources/javacc. If not, add it manually in the module's project properties

    • In IntelliJ, select Maven > Profiles and check ide-development

Deploying web site

See http://maven.apache.org/developers/website/deploy-component-reference-documentation.html

Built with Maven