README.md

release-notes-generator

This project is not actively maintained. It is archived here for reference purposes.

If you wish to maintain it, please contact the ODK team at https://getodk.org.

Installation instructions

We have these installation instructions in place while we figure how we want to publish this NPM module in the central repository.

Requirements:

• NodeJS 8.12.0 LTS
• NPM 6.4.1

Instructions:

1. Clone this repo
2. cd to the root of the repo
3. Run npm install to get all the project's dependencies
4. Run npm install -g (you might have to sudo it)

Usage instructions

Generate release notes

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

• <path>: Path to the GIT repo you want to generate a release notes for
• <version1>, and <version2>: Versions that define the range of commits your release notes will include

Example: release-notes-generator generate /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)

Feed 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>.

Print current authors

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