Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nyxb/github-craftchangelogs

Last synced: 1 day ago
JSON representation

Host: GitHub
URL: https://github.com/nyxb/github-craftchangelogs
Owner: nyxb
License: mit
Created: 2023-11-05T15:11:27.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2023-11-07T19:40:25.000Z (about 1 year ago)
Last Synced: 2024-11-21T04:43:56.153Z (2 months ago)
Language: TypeScript
Size: 73.2 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# github-craftchangelogs

[![NPM version](https://img.shields.io/npm/v/github-craftchangelogs?color=a1b858&label=)](https://www.npmjs.com/package/github-craftchangelogs)

Generate changelog for GitHub releases from [Conventional Emoji Commits](https://www.conventional-emoji-commits.site), powered by [craftchangelogs](https://github.com/nyxb/craftchangelogs).

## Features

- Support exclamation mark as breaking change, e.g. `chore!: drop node v10`
- Grouped scope in changelog
- Create the release note, or update the existing one
- List contributors

## Usage

In GitHub Actions:

```yml
# .github/workflows/release.yml

name: Release

permissions:
contents: write

on:
push:
tags:
- 'v*'

jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- uses: actions/setup-node@v3
with:
node-version: 16.x

- run: npx github-craftchangelogs # or [email protected] if ensure the stable result
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
```

It will be trigged whenever you push a tag to GitHub that starts with `v`.

## Configuration

You can put a configuration file in the project root, named as `github-craftchangelogs.config.{json,ts,js,mjs,cjs}`, `.github-craftchangelogsrc` or use the `github-craftchangelogs` field in `package.json`.

## Preview Locally

```bash
npx github-craftchangelogs --dry
```

## License