No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
acceptance-test
gradle
src
.gitignore
.travis.yml
LICENSE
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat

README.md

Download

Gradle Release Note Generator Plugin

Generate simple release notes from git log for gradle project.

Tasks

  • generateReleaseNote

Installation

buildscript {
    respositories {
        maven { url "https://dl.bintray.com/numa08/maven" }
    }
    dependencies {
        classpath 'net.numa08:genrelease:$version'
    }
}
apply plugin: 'net.numa08.genrelease'

Configurations

releaseNote closure to your build.gradle file. This closure has 3 properties.

  • version - Your application version.
  • source - Release note will be generated by this source messages.
  • output(optional) - Release note will be written this file.If empty then output stdout.

Sample

releaseNote {
 version "1.0"
 source "git log".execute()
 output file("Release.txt")
}

Spec

Release note format is Markdown. This plugin parse spec

[scope]/[subject]: [description]

  • scope
    • fix - covert to 不具合修正
    • feat - convert to 新機能
  • subject - Name for fix or feature.
  • description - description for subject.

When source is

fix/なんとか機能: どうしようもないクラッシュ問題を対応しました。
feat/いつも使う機能: 誰もが驚く世紀の大発明を実施しました
fix/なんとか機能: 悲しみあふれる闇を取り払いました
feat/ときどき使う機能: 驚天動地の新機能を実装しました。

then, will generate

## 新機能

[いつも使う機能]

 - 誰もが驚く世紀の大発明を実施しました

[ときどき使う機能]

 - 驚天動地の新機能を実装しました。

## 不具合修正

[なんとか機能]
 - どうしようもないクラッシュ問題を対応しました。
 - 悲しみあふれる闇を取り払いました