Skip to content

jonathansloman/git-changelog-gradle-plugin

 
 

Repository files navigation

Git Changelog Gradle Plugin Build Status Maven Central

This is a Gradle plugin for Git Changelog Lib.

Usage

There is a complete running example here.

There are some more examples in the build.gradle.

Here is and example that will produce a CHANGELOG.md.

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "gradle.plugin.se.bjurr.gitchangelog:git-changelog-gradle-plugin:1.45"
  }
}

apply plugin: "se.bjurr.gitchangelog.git-changelog-gradle-plugin"

task gitChangelogTask(type: se.bjurr.gitchangelog.plugin.gradle.GitChangelogTask) {
 filePath = "CHANGELOG.md";
 templateContent = new File('changelog.mustache').getText('UTF-8');
}

And then to generate CHANGELOG.md, just run gradle gitChangelog.

More documentation can be found in the Git Changelog Lib.

Developer instructions

To build the code you need to run build.sh in root of repo. You may also have a look at .travis.yml.

To do a release you need to do ./gradlew release -Dgradle.publish.key=... -Dgradle.publish.secret=... and release the artifact from staging. More information here.

About

Gradle plugin that generates a changelog or releasenotes from git repository

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 93.1%
  • HTML 4.9%
  • Shell 2.0%