https://github.com/wpsh/releaselog

Automatically generate changelog from GitHub releases
https://github.com/wpsh/releaselog

github javascript node-module nodejs readme wordpress-development

Last synced: 4 months ago
JSON representation

Automatically generate changelog from GitHub releases

• Host: GitHub
• URL: https://github.com/wpsh/releaselog
• Owner: wpsh
• License: mit
• Created: 2019-03-24T09:10:39.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-25T08:02:13.000Z (about 7 years ago)
• Last Synced: 2025-08-28T15:21:47.540Z (9 months ago)
• Topics: github, javascript, node-module, nodejs, readme, wordpress-development
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@wpsh/releaselog
• Size: 450 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Releaselog 🗒️

[![npm version](https://img.shields.io/npm/v/@wpsh/releaselog.svg)](https://www.npmjs.com/package/@wpsh/releaselog)

[![Build Status](https://travis-ci.com/wpsh/releaselog.svg?branch=master)](https://travis-ci.com/wpsh/releaselog)

[![Coverage Status](https://coveralls.io/repos/github/wpsh/releaselog/badge.svg?branch=master)](https://coveralls.io/github/wpsh/releaselog?branch=master)

Automatically build project `changelog.txt` from [GitHub release notes](https://help.github.com/en/articles/creating-releases).

## Install

Install using [`npm`](https://www.npmjs.com) as a development dependency:

```bash

npm install --save-dev @wpsh/releaselog

```

## Usage

As a [Node module](https://nodejs.org/api/modules.html):

```js

const fs = require('fs');

const releaselog = require('@wpsh/releaselog').default;

releaselog('kasparsd/widget-context-wporg') 

  .then(changelog => {

    fs.writeFile('CHANGELOG.md', `# Changelog\n\n${changelog}`, err => {

      if (err) throw err;

    });

  })

  .catch(err => console.error(err));

```

will create `CHANGELOG.md` with the following contents:

```

# Changelog

## Version 1.1.0 (2018-06-13)

- Fix URL matching for URLs with query strings.

- Introduce unit tests for the URL context.

## Version 1.0.7 (2018-06-05)

- Mark as tested with WordPress 4.9.6.

- Use the localisation service provided by [WP.org](https://translate.wordpress.org/projects/wp-plugins/widget-context).

- Support for Composer.

[..]

```

## Credits

Created by [Kaspars Dambis](https://kaspars.net).