https://github.com/bserdar/check-release-plugin

Maven plugin to make sure build artifacts are versioned correctly
https://github.com/bserdar/check-release-plugin

Last synced: about 1 month ago
JSON representation

Maven plugin to make sure build artifacts are versioned correctly

• Host: GitHub
• URL: https://github.com/bserdar/check-release-plugin
• Owner: bserdar
• License: apache-2.0
• Created: 2013-04-02T04:56:44.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-12-10T16:48:06.000Z (about 11 years ago)
• Last Synced: 2023-04-30T20:32:48.961Z (over 1 year ago)
• Language: Java
• Size: 129 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
check-release plugin makes sure that if the build artifact of a

project is semantically modified, it gets a new version number. This

ensures that any project depending on that artifact can have reliable

repeatable builds. The plugin assumes that once the project is ready

to "release" its build artifacts, it uses Maven "deploy" goal to

deploy them to a release repository. At this phase, check-release

plugin is used to make sure that:

  - if the artifact on release repository is to be overwritten, it is

  semantically identical to the new version, and

  - if the artifact is different, it is not overwritten.

Semantically identical means that changes that do not affect the

operation of the artifact are allowed, such as comments in XML files. 

For instance, suppose we're working on a Java project

`my-project:my-project` version 2.0. Once the development is ready, we

deploy it to a Maven repo on `http://my.host/release-repo`.

    

      4.0.0

      my-project

      my-project

      jar

      2.0

      

        

          ssh-repository

          http://my.host/release-repo

        

      

      

        

          

            org.apache.maven.plugins

            check-release-maven-plugin

            1.1.0

            

               http://my.host/release-repo

            

          

        

      

    

Running 

    mvn clean deploy

will build and deploy the artifact to `http://my.host/release-repo`.

If changes are made to the project, and then `mvn deploy` is run again,

the existing version (2.0) will be overwritten. However, if you deploy using

    mvn clean deploy check-release:check-release

version 2.0 will be overwritten only if the new version is

semantically equivalent to the existing version 2.0. If there are

changes that affect the operation of the artifact, check-release

plugin will fail the build.

Using 

    mvn clean install check-release:report 

will write WARNING messages instead of failing the build. This can be

run locally before publishing project artifacts to make sure

`check-release:check-release` will succeed.