https://github.com/soybeanjs/changelog

generate changelog from git tags and commits for github
https://github.com/soybeanjs/changelog

Last synced: about 2 months ago
JSON representation

generate changelog from git tags and commits for github

• Host: GitHub
• URL: https://github.com/soybeanjs/changelog
• Owner: soybeanjs
• Created: 2023-06-06T14:02:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-31T02:01:27.000Z (7 months ago)
• Last Synced: 2024-11-08T06:14:36.616Z (2 months ago)
• Language: TypeScript
• Size: 593 KB
• Stars: 4
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# @soybeanjs/changelog

generate changelog by git tags and commits

## Install

```bash

pnpm i -D @soybeanjs/changelog

```

## Usage

```ts

import {

  getChangelogMarkdown,

  getTotalChangelogMarkdown,

  generateChangelog,

  generateTotalChangelog,

} from "@soybeanjs/changelog";

// get the changelog markdown by two git tags

getChangelogMarkdown();

// get the changelog markdown by the total git tags

getTotalChangelogMarkdown();

// generate the changelog markdown by two git tags

generateChangelog();

// generate the changelog markdown by the total git tags

generateTotalChangelog();

```