https://github.com/outbrain-inc/ci-friendly-flatten-maven-plugin

https://github.com/outbrain-inc/ci-friendly-flatten-maven-plugin

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/outbrain-inc/ci-friendly-flatten-maven-plugin
• Owner: outbrain-inc
• License: apache-2.0
• Created: 2020-10-07T06:49:54.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-05T13:13:14.000Z (5 months ago)
• Last Synced: 2024-12-18T09:09:21.277Z (9 days ago)
• Language: Java
• Size: 161 KB
• Stars: 62
• Watchers: 11
• Forks: 14
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# ci-friendly-flatten-maven-plugin 

This is the [ci-friendly-flatten-maven-plugin](https://github.com/outbrain/ci-friendly-flatten-maven-plugin).

[![Apache License V.2](https://img.shields.io/badge/license-Apache%20V.2-blue.svg)](https://github.com/outbrain/ci-friendly-plugin/blob/master/LICENSE) 

[![Build Status](https://travis-ci.org/outbrain/ci-friendly-flatten-maven-plugin.svg?branch=main)](https://travis-ci.org/github/outbrain/ci-friendly-flatten-maven-plugin)

[![Maven Central](https://img.shields.io/maven-central/v/com.outbrain.swinfra/ci-friendly-flatten-maven-plugin.svg?label=Maven%20Central)](http://search.maven.org/#search%7Cga%7C1%7Cci-friendly-flatten-maven-plugin)

## Why another flatten plugin?

Having a large (> 350 modules) reactor with multiple daily releases,

we encountered two issues:

1) Commit history littered with maven release plugin commits.

2) Race between committers pushing to the main branch, and the release plugin pushing its own pom changes.

When we found out about [ci friendly versions](https://maven.apache.org/maven-ci-friendly.html), we were ecstatic - finally we can avoid having

versions in poms and achieve zero commits release process!

The only problem was that the [flatten plugin](https://www.mojohaus.org/flatten-maven-plugin) coupled with the `resolveCiFriendliesOnly`

option [does not work](https://github.com/mojohaus/flatten-maven-plugin/issues/51#issuecomment-566069689).

As adherers of the [unix philosophy](https://en.wikipedia.org/wiki/Unix_philosophy#:~:text=The%20Unix%20philosophy%20emphasizes%20building,as%20opposed%20to%20monolithic%20design.),

we decided to create a plugin that truly, really, only replaces the `revision`, `sha` and `changelist` properties. 

## Quickstart

This plugin flattens a pom by replacing `${revision}`, `${sha1}`, `${changelist}` to 

 values you set by passing them as args.

 It then writes the resulting pom to a file named `.ci-friendly-pom.xml` and sets it as the new reactor.

 For example, installing version 2.0.0:

 

    mvn -Drevision=2.0.0 clean install

   

## Plugin setup

```xml

   

        

          

            com.outbrain.swinfra

            ci-friendly-flatten-maven-plugin

            

            

              

                

                  

                  clean

                  

                  flatten

                

              

            

          

        

   

```

## Plugin Goals

 - `ci-friendly-flatten:flatten` Replaces `revision`, `sha1`, `changelist`, writes the resolved pom file to `.ci-friendly-pom.xml` and sets it as the new reactor (Default maven phase binding: process-resources).

 - `ci-friendly-flatten:clean` Removes any files created by ci-friendly-flatten:flatten (Default maven phase binding: clean).

 - `ci-friendly-flatten:version` Fetches the latest git tag, increments it and writes it to revision.txt, relies on [scm configuration](https://maven.apache.org/scm/maven-scm-plugin/usage.html).

 - `ci-friendly-flatten:scmTag` Tags the commit with the updated version and pushes the tag, relies on [scm configuration](https://maven.apache.org/scm/maven-scm-plugin/usage.html).

 

## Installing artifacts

1. To avoid having to type `-Drevision=` when installing locally, define a default revision property. 

         

            5.0.0-SNAPSHOT

         

`mvn clean install`

Will install all artifacts with 5.0.0-SNAPSHOT version.

2. Provide the version with revision arg

`mvn clean install -Drevision=`

Will install all artifacts with your provided *VERSION*

## Deploying artifacts

Same as above, just use `mvn clean deploy -Drevision=`

## How we configured it ?

1. We added *ci-friendly-flatten-maven-plugin* to our pom.xml.

2. TeamCity Configuration:

    

    - Added a project system param `system.version`.

    

    - The project build steps:

     

      - Step #0 New project should tag their project before step 1 ([git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging)) 

      

        `git tag -a "1.0.0" -m "my version '1.0.0'"`

      

        `git push origin "1.0.0"`        

      - Step #1 - (Maven step) Fetch the latest git tag, increment it and write the result to revision.txt.

      This is the version we are going to release.

        `mvn ci-friendly-flatten:version`

      - Step #2 - (Command line step) Set a `system.version` TeamCity parameter with our soon to be released version, in order to use it in the next steps

      

        ```

        #!/bin/bash -x

        VER_PATH="%teamcity.build.checkoutDir%/revision.txt"

        REV=`cat $VER_PATH`

        set +x

        echo "##teamcity[setParameter name='system.version' value='$REV']"

        ```

      - Step #3 - (Maven step) deploy

       

          `mvn clean deploy -Drevision=%system.version%`

      - Step #4 - (Maven step) Tag the current commit with the updated version and push the tag

      

          `mvn ci-friendly-flatten:scmTag -Drevision=%system.version%`