https://github.com/xogroup/origami-logs

A node changelog generator that generates your changelog into a markdown file
https://github.com/xogroup/origami-logs

changelog changelog-generator generator github node npm

Last synced: 10 months ago
JSON representation

A node changelog generator that generates your changelog into a markdown file

• Host: GitHub
• URL: https://github.com/xogroup/origami-logs
• Owner: xogroup
• License: mit
• Created: 2017-09-12T18:24:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-04T04:48:56.000Z (about 3 years ago)
• Last Synced: 2025-03-27T13:02:09.580Z (10 months ago)
• Topics: changelog, changelog-generator, generator, github, node, npm
• Language: JavaScript
• Size: 939 KB
• Stars: 3
• Watchers: 36
• Forks: 1
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# Origami Logs

A github changelog generator for your release notes.

[![Build Status](https://travis-ci.org/xogroup/origami-logs.svg?branch=master)](https://travis-ci.org/xogroup/origami-logs)

## Installation

```npm i -g origami-logs```

## First Step

Create a file named `.origami-logs-config.json` in the root of your project.

The file should look something like this:

```

{

  "github":{

    "apiUrl": "https://git.somedomain.com/api/v3",

    "token": "123456",

    "repository": "Organization/repo-name"

  }

}

```

## How to use

TO RUN:

```

changelog generate --tags "startingTag,endingTag"

```

To see all other options:

```

changelog generate --help

```

## Config Options Explained

If you wish to add other config options it might look like this:

```

{

  "github":{

    "apiUrl": "https://git.somedomain.com/api/v3",

    "token": "123456",

    "repository": "Organization/repo-name"

  },

  "aliases": {

    "enhancement": [

      "feature"

    ]

  },

  "extraLabels": {

    "chore": "Chores Completed:"

  },

  "extras": {

    "pivotal":{

      "boardID": "1234567"

    }

  }

}

```

* `github`: *REQUIRED* The info about the given repository you wish to get the changelog format for markdown

* `aliases`: This is to be used if you want to use your own custom labels but still conform to the enhance/bug format.

  * IE: You might have a feature label but still want it to show `Features Implemented` on the changelog.

* `extraLabels`: Define your own custom labels and changelog headings

* `extras`: Where additional connections live

  * `pivotal`: Supports linking pivotal stories in your change log assuming commits conform to the format:

    `[#STORY_ID_HERE] Commit Message here`

    * `boardID`: Pivotal Board ID (Found at the end of the url such as `https://www.pivotaltracker.com/n/projects/ID-HERE`)

    

    

    

## Development

To test locally run

```

node cli.js generate --tags "TAG1,TAG2"

```