Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aneoconsulting/order-github-release-notes
Organize auto generated changelog using the GitHub API
https://github.com/aneoconsulting/order-github-release-notes
changelog github notes release
Last synced: about 1 month ago
JSON representation
Organize auto generated changelog using the GitHub API
- Host: GitHub
- URL: https://github.com/aneoconsulting/order-github-release-notes
- Owner: aneoconsulting
- License: mit
- Created: 2023-05-04T08:27:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-28T09:29:18.000Z (10 months ago)
- Last Synced: 2024-08-09T03:08:52.031Z (5 months ago)
- Topics: changelog, github, notes, release
- Language: TypeScript
- Homepage:
- Size: 70.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# order-github-release-notes
[](https://www.npmjs.com/package/@aneoconsultingfr/order-github-release-notes)
Organize auto generated changelog using the GitHub API in order to allow merge commit (instead of squash).
Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), powered by [changelogen](https://github.com/unjs/changelogen).
We use
## Features
- Organize auto generated changelog using the GitHub API
- Allow merge commit
- 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 @aneoconsultingfr/order-github-release-notes
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 `order-github-release-notes.config.{json,ts,js,mjs,cjs}`, `.order-github-release-notesrc` or use the `order-github-release-notes` field in `package.json`.
## Preview Locally
```bash
export GITHUB_TOKEN=$(gh auth token)
```
```bash
npx @aneoconsultingfr/order-github-release-notes --dry
```
In order to avoid to use a GitHub token, you can use the `--input` flag to provide data.
```bash
npx @aneoconsultingfr/order-github-release-notes --input '* feat: a new feature
* fix: a bug fix
* docs: documentation only changes
* @new-contributor: a new contributor
'
```
## Dev
```bash
nci -D
```
## License
[MIT](./LICENSE) License © 2023 [Aneo](https://github.com/aneoconsulting)
## Credits
Heavily inspired by [changelogithub](https://github.com/antfu/changelogithub) from [Anthony Fu](https://github.com/antfu)