https://github.com/gentics/changelog-manager-plugin

Maven Changelog Plugin
https://github.com/gentics/changelog-manager-plugin

Last synced: about 2 months ago
JSON representation

Maven Changelog Plugin

• Host: GitHub
• URL: https://github.com/gentics/changelog-manager-plugin
• Owner: gentics
• License: apache-2.0
• Created: 2014-03-05T10:00:22.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-07-31T13:03:57.000Z (over 1 year ago)
• Last Synced: 2024-04-08T16:21:12.420Z (9 months ago)
• Language: CSS
• Size: 630 KB
• Stars: 1
• Watchers: 7
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Maven Changelog Plugin

The maven changelog plugin can be used to create custom changelogs.

The following components/directories are used to create the final changelog:

* `entries`: 

 Entries are the basic building blocks. An entry is basically a file that 

 contains the changelog message. Each changelog entry is a separate file. 

 The file extension and filename determines the type of the changelog entry. 

 There are for example bugfix, enhancement, manualchange and so on.

* `mappings`:

A mapping is a json file that contains the information what entries are combined 

to form one changelog. The mapping also contains additional properties that can 

be used within the rendering of the changelog template file. Skip lists also go

here (see below).

* `templates`:

The templates define how the mapping information and the entries should be 

transformed into html. You can configure the changelog overview templates by

setting the overviewTemplateFileNames tag value.

Additionally there is an 'changelog.vm' template. This template is used generate 

a single html file for each mapping.

* `static`:

This directory just contains basic static files like css and images that are used

to style the generated html changelog.

## Skip lists and the re-use of entries across branches

 

The `generate` goal will try to find unmapped changelog entries for a new changelog.

Normally, it does this by examining all existing mappings to figure out which

entries are not yet mapped.

If your project has a workflow with multiple branches that receive the same bugfixes,

you can use skip lists. The plugin distinguishes different branches by the major

and minor version numbers of the `changelogVersion` property.

Skip lists are files stored in the `mappings` folder and are named like `skiplist_x.y.0.lst`,

where x and y are the major and minor version numbers of the associated branch. The file

consists of filenames of changelog entries (without any paths), one per line.

A skip list has the following effects:

* If a skip list exists for the current branch, an entry is considered "not yet mapped",

even if it occurs in the changelog of an earlier minor version (e.g. an entry is considered

unmapped for 3.1.5, even if it is already mapped for version 3.0.27 and/or 1.2.7).

* Changelog entries mentioned in the skip list for the current branch are not considered,

even if they are unmapped.

## Example

	

		com.gentics

		    changelog-manager-plugin

		1.0-SNAPSHOT

		

			

				generate-resources

				

					generate

				

			

		

		

			

			true

			

			${basedir}/src/changelog

			

			${basedir}/target/output

			

			Gentics Content.Node Changelog

			

			manualchange,feature,enhancement,bugfix

			

			1.2.112

			

			false

			

			index.vm, merged_changelog.vm, plain_merged_changelog.vm

			

			false

			

			 

			

				

					alohaeditor-version

					0.9.3

				

				

					alohaeditor-date

					2012/12/12