Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maximousblk/ghlog
Generate release notes based on GitHub Commits
https://github.com/maximousblk/ghlog
changelog deno github
Last synced: 3 months ago
JSON representation
Generate release notes based on GitHub Commits
- Host: GitHub
- URL: https://github.com/maximousblk/ghlog
- Owner: maximousblk
- License: mit
- Created: 2021-02-05T11:20:41.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-25T03:23:34.000Z (over 2 years ago)
- Last Synced: 2024-10-16T23:05:36.118Z (4 months ago)
- Topics: changelog, deno, github
- Language: TypeScript
- Homepage: https://deno.land/x/ghlog
- Size: 58.6 KB
- Stars: 13
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ghlog
Generate release notes based on GitHub Commits.
`ghlog` categorises the commits based on
[Conventional Commits](https://www.conventionalcommits.org). All the commits
that don't follow the CC patern are not considered.
try it now:
```
deno run -A https://deno.land/x/ghlog/ghlog.ts nestdotland/nest
```
## Install
You can install `ghlog` using the following command.
```sh
deno install -A https://deno.land/x/ghlog/ghlog.ts
```
## Usage
```sh
ghlog [ ...arguments ] [ ...options ]
```
#### Arguments
| argument | default | description |
| ------------ | -------------------------- | ------------------------- |
| `[base_ref]` | last tag or initial commit | git ref to newest commit. |
| `[head_ref]` | the latest commit | git ref to oldest commit. |
#### Options
| option | default | description |
| --------------- | -------------- | ---------------------------------------- |
| `-h, --help` | | show help |
| `-o, --output` | `CHANGELOG.md` | location to release notes output |
| `-v, --version` | `UNRELEASED` | tag to use in release notes |
| `-d, --date` | current date | release date |
| `-n, --name` | | name to use in release notes |
| `-a, --append` | | append to existing changelog |
| `--auth` | | GitHub access token to avoid rate limits |
You can also use the `GITHUB_TOKEN` environment variable to use the GitHub
access token.
## Templates
`ghlog` provides a sane default template out of the box that works great in most
situations, but if you want a more custom template, you can use the
[`examples/`](./examples) directory for reference and create your own templates.
## License
This software is released under [The MIT License](LICENSE)