https://github.com/soybeanjs/changelog
generate changelog from git tags and commits for github
https://github.com/soybeanjs/changelog
Last synced: 6 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 (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T02:26:42.000Z (over 1 year ago)
- Last Synced: 2025-03-26T14:53:14.397Z (about 1 year ago)
- Language: TypeScript
- Size: 361 KB
- Stars: 5
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
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();
```