ax_generate_changelog (Autoconf Archive)

ax_generate_changelog

Synopsis

AX_GENERATE_CHANGELOG()

Description

Builds a rule for generating a ChangeLog file from version control system commit messages. Currently, the only supported VCS is git, but support for others could be added in future.

Defines GENERATE_CHANGELOG_RULES which should be substituted in your Makefile.

Usage example:

configure.ac:

  AX_GENERATE_CHANGELOG

Makefile.am:

  @GENERATE_CHANGELOG_RULES@
  CHANGELOG_START = 0.2.3^
  dist-hook: dist-ChangeLog

ChangeLog (stub committed to VCS):

  The ChangeLog is auto-generated when releasing.
  If you are seeing this, use 'git log' for a detailed list of changes.

This results in a "dist-ChangeLog" rule being added to the Makefile. When run, "dist-ChangeLog" will generate a ChangeLog in the $(top_distdir), using $(CHANGELOG_GIT_FLAGS) to format the output from "git log" being run in $(CHANGELOG_GIT_DIR).

Unless Automake is initialised with the ’foreign’ option, a dummy ChangeLog file must be committed to VCS in $(top_srcdir), containing the text above (for example). It will be substituted by the automatically generated ChangeLog during "make dist".

Source Code

Download the latest version of ax_generate_changelog.m4 or browse the macro’s revision history.

License

Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty.