{"meta":{"title":"Building and testing Java with Maven","intro":"Learn how to create a continuous integration (CI) workflow in GitHub Actions to build and test your Java project with Maven.","product":"GitHub Actions","breadcrumbs":[{"href":"/en/enterprise-cloud@latest/actions","title":"GitHub Actions"},{"href":"/en/enterprise-cloud@latest/actions/tutorials","title":"Tutorials"},{"href":"/en/enterprise-cloud@latest/actions/tutorials/build-and-test-code","title":"Build and test code"},{"href":"/en/enterprise-cloud@latest/actions/tutorials/build-and-test-code/java-with-maven","title":"Java with Maven"}],"documentType":"article"},"body":"# Building and testing Java with Maven\n\nLearn how to create a continuous integration (CI) workflow in GitHub Actions to build and test your Java project with Maven.\n\n## Introduction\n\nThis guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Maven software project management tool. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to cache files and upload artifacts from a workflow run.\n\nGitHub-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Maven. For a list of software and the pre-installed versions for JDK and Maven, see [GitHub-hosted runners](/en/enterprise-cloud@latest/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software).\n\n## Prerequisites\n\nYou should be familiar with YAML and the syntax for GitHub Actions. For more information, see:\n\n* [Workflow syntax for GitHub Actions](/en/enterprise-cloud@latest/actions/using-workflows/workflow-syntax-for-github-actions)\n* [Writing workflows](/en/enterprise-cloud@latest/actions/learn-github-actions)\n\nWe recommend that you have a basic understanding of Java and the Maven framework. For more information, see the [Maven Getting Started Guide](https://maven.apache.org/guides/getting-started/index.html) in the Maven documentation.\n\n## Using a Maven workflow template\n\nTo get started quickly, add a workflow template to the `.github/workflows` directory of your repository.\n\nGitHub provides a workflow template for Maven that should work for most Java with Maven projects. The subsequent sections of this guide give examples of how you can customize this workflow template.\n\n1. On GitHub, navigate to the main page of the repository.\n\n2. Under your repository name, click ** Actions**.\n\n ![Screenshot of the tabs for the \"github/docs\" repository. The \"Actions\" tab is highlighted with an orange outline.](/assets/images/help/repository/actions-tab-global-nav-update.png)\n\n3. If you already have a workflow in your repository, click **New workflow**.\n\n4. The \"Choose a workflow\" page shows a selection of recommended workflow templates. Search for \"Java with Maven\".\n\n5. On the \"Java with Maven\" workflow, click **Configure**.\n\n6. Edit the workflow as required. For example, change the Java version.\n\n7. Click **Commit changes**.\n\n The `maven.yml` workflow file is added to the `.github/workflows` directory of your repository.\n\n### Specifying the Java version and architecture\n\nThe workflow template sets up the `PATH` to contain OpenJDK 8 for the x64 platform. If you want to use a different version of Java, or target a different architecture (`x64` or `x86`), you can use the `setup-java` action to choose a different Java runtime environment.\n\nFor example, to use version 11 of the JDK provided by Adoptium for the x64 platform, you can use the `setup-java` action and configure the `java-version`, `distribution` and `architecture` parameters to `'11'`, `'temurin'` and `x64`.\n\n```yaml copy\nsteps:\n - uses: actions/checkout@v6\n - name: Set up JDK 11 for x64\n uses: actions/setup-java@v4\n with:\n java-version: '11'\n distribution: 'temurin'\n architecture: x64\n```\n\nFor more information, see the [`setup-java`](https://github.com/actions/setup-java) action.\n\n## Building and testing your code\n\nYou can use the same commands that you use locally to build and test your code.\n\nThe workflow template will run the `package` target by default. In the default Maven configuration, this command will download dependencies, build classes, run tests, and package classes into their distributable format, for example, a JAR file.\n\nIf you use different commands to build your project, or you want to use a different target, you can specify those. For example, you may want to run the `verify` target that's configured in a `pom-ci.xml` file.\n\n```yaml copy\nsteps:\n - uses: actions/checkout@v6\n - uses: actions/setup-java@v4\n with:\n java-version: '17'\n distribution: 'temurin'\n - name: Run the Maven verify phase\n run: mvn --batch-mode --update-snapshots verify\n```\n\n## Caching dependencies\n\nYou can cache your dependencies to speed up your workflow runs. After a successful run, your local Maven repository will be stored in a cache. In future workflow runs, the cache will be restored so that dependencies don't need to be downloaded from remote Maven repositories. You can cache dependencies simply using the [`setup-java` action](https://github.com/marketplace/actions/setup-java-jdk) or can use [`cache` action](https://github.com/actions/cache) for custom and more advanced configuration.\n\n```yaml copy\nsteps:\n - uses: actions/checkout@v6\n - name: Set up JDK 17\n uses: actions/setup-java@v4\n with:\n java-version: '17'\n distribution: 'temurin'\n cache: maven\n - name: Build with Maven\n run: mvn --batch-mode --update-snapshots verify\n```\n\nThis workflow will save the contents of your local Maven repository, located in the `.m2` directory of the runner's home directory. The cache key will be the hashed contents of `pom.xml`, so changes to `pom.xml` will invalidate the cache.\n\n## Packaging workflow data as artifacts\n\nAfter your build has succeeded and your tests have passed, you may want to upload the resulting Java packages as a build artifact. This will store the built packages as part of the workflow run, and allow you to download them. Artifacts can help you test and debug pull requests in your local environment before they're merged. For more information, see [Store and share data with workflow artifacts](/en/enterprise-cloud@latest/actions/using-workflows/storing-workflow-data-as-artifacts).\n\nMaven will usually create output files like JARs, EARs, or WARs in the `target` directory. To upload those as artifacts, you can copy them into a new directory that contains artifacts to upload. For example, you can create a directory called `staging`. Then you can upload the contents of that directory using the `upload-artifact` action.\n\n```yaml copy\nsteps:\n - uses: actions/checkout@v6\n - uses: actions/setup-java@v4\n with:\n java-version: '17'\n distribution: 'temurin'\n - run: mvn --batch-mode --update-snapshots verify\n - run: mkdir staging && cp target/*.jar staging\n - uses: actions/upload-artifact@v4\n with:\n name: Package\n path: staging\n```"}