Releases: aldrin/git-changelog
v0.3.1
Summary
Features
-
The tool now accepts
git logarguments to choose
commits to be included in the report. For example:# My changes in reverse chronological order > git changelog -- --author aldrin --reverse
# All changes since yesterday > git changelog -- --since yesterday
Note that you need a
--before you begingit logarguments. -
Values for the command line arguments
--templateand
--remotecan now be specified in configuration file as well.
v0.3.0
Summary
Features
- Markdown output is tidier as includes revision range and timestamps in the generated report. The report can also be produced to JSON to support dynamic renderings (if required).
Breaking Changes
- The input to the tool is rearranged and now separates project conventions from output preferences under separate YAML nodes. This implies that external configuration files would require some tweaks. See .changelog.yml and src/assets/changelog.yml for the new format.
v0.2.1
v0.2.0
Summary
- Simplify configuration and group by tag titles (#2)
- Improve configuration file lookup and support post-processors (#3)
Features
-
Simplify configuration by omitting tags, defaults, etc. All we need now are simple keyword->title mapping and keywords without titles are skipped from the report. The aggregation is now done on title (instead of tag keyword) which allows us to group multiple tags into one report section. For example, with tags
break => Breaking Changeandbraek => Breaking Changewe can accommodate simple typos. -
The tool now automatically uses a configuration file
.changelog.ymlin the current directory. If a file with that name doesn't exist in the current directory, it looks up the directory tree in the parent directories as long as it reaches the root. This simplifies project specific configuration by checking in a.changelog.ymlin the repo root. -
The configuration can now specifiy post-processors that look for specific markers like (e.g.
JIRA-12345) and replaces them with suitable replacements. This makes adding links like JIRA-1234 easy. In general, a post-processor is a(lookup,replacement)tuple where alookupis a regex with named capture groups likeJIRA-(?P<ticket>\\d+)) and replacement is a simple string that refers to the named capture groups like[JIRA-$ticket](http://jira.company.com/view/JIRA-$ticket)
Breaking Changes
- Configuration format has changed and old configuration files will need some tweaks.