https://github.com/offa/maven-action

GitHub Action to build Maven projects with different Java JDK versions.
https://github.com/offa/maven-action

github-action github-action-java github-action-maven github-actions java maven

Last synced: about 2 hours ago
JSON representation

GitHub Action to build Maven projects with different Java JDK versions.

• Host: GitHub
• URL: https://github.com/offa/maven-action
• Owner: offa
• License: gpl-3.0
• Created: 2021-09-28T14:52:49.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-04T18:37:26.000Z (15 days ago)
• Last Synced: 2024-11-07T07:52:44.053Z (12 days ago)
• Topics: github-action, github-action-java, github-action-maven, github-actions, java, maven
• Language: Java
• Homepage:
• Size: 73.2 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# maven-action

[![ci](https://github.com/offa/maven-action/actions/workflows/ci.yml/badge.svg)](https://github.com/offa/maven-action/actions/workflows/ci.yml)

[![GitHub release](https://img.shields.io/github/release/offa/maven-action.svg)](https://github.com/offa/maven-action/releases)

[![License](https://img.shields.io/badge/license-GPLv3-yellow.svg)](LICENSE)

GitHub Action for Maven based projects.

It checks out the repository, sets up Java, runs Maven and optional analysis.

### Example

Minimal example:

```yml

- uses: offa/maven-action@main

  with:

    java-version: '21'

```

Builds JDK 17 and 21 and executes a PMD analysis:

```yml

# […]

jobs:

  build:

    runs-on: ubuntu-latest

    strategy:

      matrix:

        java: [ 17, 21 ]

    name: jdk-${{ matrix.java }}

    steps:

      - name: Build

        uses: offa/maven-action@main

        with:

          java-version: ${{ matrix.java }}

          pmd: true

```

### Usage

`java-version` is required, all other settings are optional with defaults

```yml

- uses: offa/maven-action@main

  with:

    # Java version to use (required) - whole or semver Java version

    java-version: # Required

    # Path to pom.xml file or directory containing one

    pom: 'pom.xml'

    # Maven goal to execute

    goal: 'verify'

    # Execute PMD goal (runs after 'goal')

    pmd: false

    # Skips JavaDoc generation

    skip-javadoc: true

```