Skip to content

Idea Run Configurations

Jump to bottom
Asterios Raptis edited this page Aug 17, 2024 · 1 revision

Available Run Configurations

Here are the documetation of all run configurations in the repository:

  1. Build with Warnings Mode

    • Name: java-library-template [build --warning-mode all]
    • Purpose: Similar to the standard build configuration, but with an additional script parameter that enables Gradle's warning mode for all warnings. This is useful for identifying potential issues in your build process.
    • Details:
      • Task: build
      • Script Parameters: --warning-mode all
      • VM Options: None
      • Debugging: Enabled for external processes.

  2. Build Configuration

    • Name: java-library-template [build]
    • Purpose: This configuration is used to execute the Gradle build task. It compiles the project, runs tests, and packages the application as specified in your Gradle build file.
    • Details:
      • Task: build
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  3. Clean, Publish, and Tag Release

    • Name: java-library-template [clean publishMavenJavaPublicationToMavenLocal publish tagRelease]
    • Purpose: This configuration cleans the build, publishes the Maven Java publication to the local Maven repository, publishes the library to the specified repository, and tags the release.
    • Details:
      • Tasks: clean, publishMavenJavaPublicationToMavenLocal, publish, tagRelease
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  4. Clean and Publish to Maven Local

    • Name: java-library-template [clean publishMavenJavaPublicationToMavenLocal publish]
    • Purpose: This configuration cleans the build, publishes the Maven Java publication to the local Maven repository, and then publishes the library to the specified repository.
    • Details:
      • Tasks: clean, publishMavenJavaPublicationToMavenLocal, publish
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  5. Clean Task

    • Name: java-library-template [clean]
    • Purpose: This configuration is used to clean the project by deleting the build directory.
    • Details:
      • Task: clean
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  6. Dependencies Report

    • Name: java-library-template [dependencies]
    • Purpose: This configuration is used to generate a report of all dependencies in the project. It's useful for reviewing the libraries and versions your project relies on.
    • Details:
      • Task: dependencies
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  7. JaCoCo Test Coverage Verification

    • Name: java-library-template [jacocoTestCoverageVerification]
    • Purpose: Verifies if the code coverage meets the specified thresholds in the build.
    • Details:
      • Task: jacocoTestCoverageVerification
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  8. JaCoCo Test Report

    • Name: java-library-template [jacocoTestReport]
    • Purpose: This configuration is used to generate a code coverage report using JaCoCo.
    • Details:
      • Task: jacocoTestReport
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  9. Javadoc Generation

    • Name: java-library-template [javadoc]
    • Purpose: This configuration generates the Javadoc for the project, useful for documentation purposes.
    • Details:
      • Task: javadoc
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  10. License Formatting

    • Name: java-library-template [licenseFormat]
    • Purpose: Formats the project files according to the license specifications.
    • Details:
      • Task: licenseFormat
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  11. Publish

  • Name: java-library-template [publish]
  • Purpose: This configuration is used to publish the library to the specified repository.
  • Details:
    • Task: publish
    • Script Parameters: None
    • VM Options: None
    • Debugging: Enabled for external processes.

  1. Publish to Maven Local

    • Name: java-library-template [publishMavenJavaPublicationToMavenLocal]
    • Purpose: Publishes the Java artifacts to your local Maven repository.
    • Details:
      • Task: publishMavenJavaPublicationToMavenLocal
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  2. Spotless Apply

    • Name: java-library-template [spotlessApply]
    • Purpose: Applies code formatting to the entire project according to Spotless configurations.
    • Details:
      • Task: spotlessApply
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  3. Spotless Apply (Java Files)

    • Name: java-library-template [spotlessJavaApply]
    • Purpose: Applies code formatting specifically to Java files in the project.
    • Details:
      • Task: spotlessJavaApply
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  4. Spotless Apply (Miscellaneous Files)

    • Name: java-library-template [spotlessMiscApply]
    • Purpose: Applies code formatting to miscellaneous files as specified in the Spotless configuration.
    • Details:
      • Task: spotlessMiscApply
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  5. Tag Release

    • Name: java-library-template [tagRelease]
    • Purpose: This configuration tags a new release in the version control system.
    • Details:
      • Task: tagRelease
      • Script Parameters: None
      • VM Options: None
      • Debugging: Enabled for external processes.

  6. Version Catalog Format

  • Name: java-library-template [versionCatalogFormat]
  • Purpose: Formats the version catalog file for the project.
  • Details:
    • Task: versionCatalogFormat
    • Script Parameters: None
    • VM Options: None
    • Debugging: Enabled for external processes.
  1. Version Catalog Update
  • Name: java-library-template [versionCatalogUpdate]
  • Purpose: Updates the version catalog file with the latest versions.
  • Details:
    • Task: versionCatalogUpdate
    • Script Parameters: None
    • VM Options: None
    • Debugging: Enabled for external processes.

Clone this wiki locally