https://github.com/heuermh/github-changes-maven-plugin

Maven changes plugin for GitHub hosted repositories. Apache 2 licensed.
https://github.com/heuermh/github-changes-maven-plugin

changelog-generator github java maven maven-plugin

Last synced: 3 months ago
JSON representation

Maven changes plugin for GitHub hosted repositories. Apache 2 licensed.

• Host: GitHub
• URL: https://github.com/heuermh/github-changes-maven-plugin
• Owner: heuermh
• License: apache-2.0
• Created: 2018-06-06T17:37:44.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-10-12T22:17:10.000Z (over 4 years ago)
• Last Synced: 2025-02-09T05:37:58.302Z (over 1 year ago)
• Topics: changelog-generator, github, java, maven, maven-plugin
• Language: Java
• Homepage:
• Size: 31.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# github-changes-maven-plugin

Maven changes plugin for GitHub hosted repositories.

[![Build Status](https://travis-ci.org/heuermh/github-changes-maven-plugin.svg?branch=master)](https://travis-ci.org/heuermh/github-changes-maven-plugin)

[![Maven Central](https://img.shields.io/maven-central/v/com.github.heuermh.maven.plugin.changes/github-changes-maven-plugin.svg?maxAge=600)](http://search.maven.org/#search%7Cga%7C1%7Ccom.github.heuermh.maven.plugin.changes)

### Hacking github-changes-maven-plugin

Install

 * JDK 1.8 or later, http://openjdk.java.net

 * Apache Maven 3.8.3 or later, http://maven.apache.org

To build

    $ mvn install

### Running github-changes-maven-plugin

Run the `github-changes-maven-plugin` specifying the GitHub milestone identifier.

```bash

$ mvn \

    com.github.heuermh.maven.plugin.changes:github-changes-maven-plugin:1.2:github-changes \

    -DmilestoneId=1

```

The GitHub repository is parsed from the project issue management URL. If this is not specified

in `pom.xml`, it can be provided via `-DissueManagementUrl=https://github.com/user/repo/issues`

parameter.

Changes from closed issues and merged or closed pull requests associated with the specified

GitHub milestone identifier are written to the changes file `CHANGES.md` (which can be specified

via `-DchangesFile=my-changes.md` parameter) in Markdown format.

An example `CHANGES.md` file maintained by this plugin may be seen in the

[bigdatagenomics/adam](https://github.com/bigdatagenomics/adam) repository at:

https://github.com/bigdatagenomics/adam/blob/master/CHANGES.md