Repository files navigation

This GitHub Action is a composite action designed to standardize the build process for Java/Maven projects. It handles several key aspects of the build process:

1. Java environment setup
2. Maven configuration
3. Version management
4. Build process execution
5. Artifact handling and deployment

The action adapts its behavior based on the branch being built (master/main, hotfix, or development branches), applying different versioning strategies and build processes accordingly.

• version: The version of the built artifact, accessible via${{ steps.set-version.outputs.version }}

The action begins by setting up the Java environment using the officialactions/setup-java@v4 action to install the specified Java version and distribution.

The action configures Maven with caching to speed up builds. It supports two caching mechanisms:

• Local Cache: Usesactions/cache@v4 to cache the Maven repository locally within GitHub Actions.
• S3 Cache: Whenaws_role_arn is provided, usesruns-on/cache@v4 with AWS S3 for more persistent and shared caching across workflows.

The action also usesstCarolas/setup-maven@v5 to set up the specified Maven version.

The action configures Git with a specific user identity ("clearci") to ensure consistent commit authoring and proper access to repositories.

The action determines the type of branch being built:

• A master/main branch
• A hotfix branch
• Any other branch (development)

The result is stored as outputs (hotfix andmaster) for use in subsequent steps.

The action implements sophisticated version management based on the branch type:

• Master/Main Branch: Increments the minor version and sets patch to 0 (e.g., 1.2.0 → 1.3.0)
• Hotfix Branch:
  • Checks if the current version has a qualifier
  • If not, increments the patch version and adds a SNAPSHOT suffix
  • Commits this change to the repository
  • Uses the version without the SNAPSHOT suffix for the build
• Other Branches: Uses a development version based on the first 8 characters of the commit SHA (e.g., dev-a1b2c3d4)

The build process varies based on the branch type:

This performs a full Maven release process with:

• Skipping tests
• Creating a Git tag with the format "v{version}"
• Adding "[ci skip]" prefix to commit messages
• Using the version determined in the previous step

This performs a standard Maven package operation, skipping tests.

For production builds (master/hotfix), artifacts can optionally be deployed to a Maven repository whenpublish_artifacts is set to 'true'. This step:

• Checks out the tag created during the release process
• Deploys the artifacts using Maven's deploy goal with settings from.mvn/settings.xml

Finally, all builds upload artifacts to GitHub Actions, making the built JAR files available for download from the GitHub Actions interface, with a retention period of 1 day.

The action implements a sophisticated branch-based strategy:

1. Master/Main Branch:

   • Treated as production releases
   • Increments minor version (1.2.0 → 1.3.0)
   • Performs full Maven release with tagging
   • Optionally deploys artifacts

2. Hotfix Branch:

   • Special handling for urgent fixes
   • Increments patch version if needed (1.2.0 → 1.2.1)
   • Performs full Maven release with tagging
   • Optionally deploys artifacts

3. Other Branches:

   • Treated as development builds
   • Uses commit-based versioning (dev-a1b2c3d4)
   • Performs standard Maven package operation
   • Does not deploy artifacts (but still uploads them to GitHub Actions)

1. Automated Version Management: Automatically determines appropriate version numbers based on branch type and existing version.

2. Conditional Build Processes: Adapts the build process based on the branch type.

3. Artifact Management: Uploads artifacts for all builds and optionally deploys them for production builds.

4. Caching: Implements Maven repository caching to improve build performance, with support for both local GitHub Actions cache and S3-based caching.

5. Configurable Environment: Allows customization of Java version, distribution, Maven version, and other parameters.

This composite action provides a standardized, reliable, and maintainable build process for Java/Maven projects, with sophisticated version management and branch-based strategies.

The action supports using Amazon S3 for caching Maven dependencies, which provides several advantages over the standard GitHub Actions cache:

1. Persistent Storage: Cache persists beyond the 7-day limit of GitHub Actions cache
2. Cross-Workflow Sharing: Cache can be shared across different workflows and repositories
3. Improved Performance: Potentially faster cache operations, especially for large dependency sets

To use the S3 cache functionality:

1. AWS Role ARN: Provide an AWS Role ARN via theaws_role_arn input parameter
2. Permissions: The GitHub workflow must havepermissions: write-all set to allow the action to configure AWS credentials
3. S3 Bucket: The action uses a predefined S3 bucket (ct-github-action-cache) in theap-south-1 region

name:Build with S3 Cacheon:push:branches:[ main ]jobs:build:runs-on:ubuntu-latestpermissions:write-allsteps:      -uses:actions/checkout@v4            -name:Build with Javauses:cleartax/build-java@mainwith:token:${{ secrets.GITHUB_TOKEN }}aws_role_arn:${{ secrets.AWS_ASSUME_ROLE_ARN }}

Whenaws_role_arn is not provided, the action automatically falls back to using the standard GitHub Actions cache.