https://github.com/gocom/changelog

Extracts releases notes from CHANGELOG.md
https://github.com/gocom/changelog

Last synced: 5 months ago
JSON representation

Extracts releases notes from CHANGELOG.md

• Host: GitHub
• URL: https://github.com/gocom/changelog
• Owner: gocom
• License: mit
• Created: 2025-07-21T16:37:18.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-08-14T18:17:29.000Z (10 months ago)
• Last Synced: 2025-09-12T05:53:25.529Z (9 months ago)
• Language: TypeScript
• Size: 132 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
Changelog

=====

[![npm](https://img.shields.io/npm/v/%40gocom%2Fchangelog)](https://www.npmjs.com/package/@gocom/changelog) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gocom_changelog&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gocom_changelog) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=gocom_changelog&metric=coverage)](https://sonarcloud.io/summary/new_code?id=gocom_changelog) [![MIT](https://img.shields.io/badge/license-MIT-green)](https://github.com/gocom/changelog/blob/main/LICENSE) ![TypeScript](https://img.shields.io/badge/types-TypeScript-blue)

Extract version changelogs from CHANGELOG.md. The library enables parsing Markdown formatted changelog documents,

and extracting details and release notes from the contents. Written in TypeScript, and supports both client-side

web browser and Node.js backend usage.

⚡ Install

-----

Using npm:

```shell

$ npm install @gocom/changelog

```

📖 Documentation

-----

See [API Docs](https://github.com/gocom/changelog/blob/docs/main/Public/API.md).

📝 Example Usage

-----

### Parsing changelog

The following would parse the given changelog document string, and returns the results as an array of objects:

```typescript

import {parse} from '@gocom/changelog';

const changelog = parse(`

# Changelog

### 1.1.0-alpha.1

* Change 1.

* Change 2.

### 1.0.0 🚀

* Initial public release.

`);

```

The above `changelog` variable would become:

```typescript

[

  {

    version: '1.1.0-alpha.1',

    isPrerelease: true,

    titleStart: '',

    titleEnd: '',

    notes: '* Change 1.\n* Change 2.'

  },

  {

    version: '1.0.0',

    isPrerelease: false,

    titleStart: '',

    titleEnd: '🚀',

    notes: '* Initial public release.'

  }

];

```

For more see [documentation](https://github.com/gocom/changelog/blob/docs/main/Public/API.md).

🛠️ Development

-----

See [CONTRIBUTING.md](https://github.com/gocom/changelog/blob/main/CONTRIBUTING.md).