https://github.com/apitable/github-changelog-builder

Quick build a beautiful github-friendly changelog from commits between two tags or commits with Github API
https://github.com/apitable/github-changelog-builder

Last synced: 10 months ago
JSON representation

Quick build a beautiful github-friendly changelog from commits between two tags or commits with Github API

• Host: GitHub
• URL: https://github.com/apitable/github-changelog-builder
• Owner: apitable
• License: mit
• Created: 2022-11-04T10:56:19.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-10T04:07:44.000Z (over 2 years ago)
• Last Synced: 2025-04-10T03:16:54.701Z (10 months ago)
• Language: TypeScript
• Homepage:
• Size: 33.2 KB
• Stars: 4
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          

![apphook](https://socialify.git.ci/apitable/github-changelog-builder/image?description=1&font=Inter&language=1&name=1&pattern=Diagonal%20Stripes&stargazers=1&theme=Dark)

# github-changelog-builder 

[![npm](https://img.shields.io/npm/v/github-changelog-builder)](https://www.npmjs.com/package/github-changelog-builder)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/apitable/github-changelog-builder/npm-publish)](https://github.com/apitable/github-changelog-builder/actions)

[![npm bundle size](https://img.shields.io/bundlephobia/min/github-changelog-builder)](https://www.npmjs.com/package/github-changelog-builder)

[![npm](https://img.shields.io/npm/dm/github-changelog-builder)](https://www.npmjs.com/package/github-changelog-builder)

Quick build a beautiful github-friendly changelog from commits between two tags or commits with Github API

## Usage

```

npx github-changelog-builder \

                        --token ${YOUR_GITHUB_TOKEN:-TOKEN} \

                        --owner ${GITHUB_OWNER:-apitable} \

                        --repo ${GITHUB_REPO:-apitable} \

                        --from ${FROM:-d36e31baa93655db5b6bb38843a7dfe625b08749} \

                        --to ${TO:-HEAD} \

                        --append-file ${CHANGELOG_FILE:-CHANGELOG.md}

```

## Example

My [CHANGELOG.md](./CHANGELOG.md) is generated by github-changelog-builder.