search

getodk / release-notes-generator

NPM module to generate release notes with attribution
0 stars 2 forks source link

Issue 1 issue 2 #4

Closed ggalmazor closed 5 years ago

ggalmazor commented 5 years ago

Closes #1

New usage instructions:

Usage instructions

Run this tool with release-notes-generator generate <path> <version1> <version2>. Arguments:

Example: release-notes-generator /home/guillermo/src/odk/briefcase v1.11.0 v1.12.0

(This will generate a release notes for Briefcase between versions v1.11.0 and v1.12.0)

Advanced usage: preload authors table

Use the following JSON file as a template to feed the authors to the tool:

[
  {
    "name": "Jane Doe",
    "email": "jane@doe.com",
    "username": "the-jane-doe",
    "organization": "Doe & Doe Corp."
  }
]

You can feed a JSON with authors with the command release-notes-generator feed-authors <path>.

You can check the current authors table (and use it as a template as well) with the command release-notes-generator print-authors