Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chelnak/gh-changelog
A gh cli extension that will make your changelogs ✨
https://github.com/chelnak/gh-changelog
changelog gh-extension golang hacktoberfest
Last synced: 28 days ago
JSON representation
A gh cli extension that will make your changelogs ✨
- Host: GitHub
- URL: https://github.com/chelnak/gh-changelog
- Owner: chelnak
- License: mit
- Created: 2022-04-14T20:47:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T08:18:37.000Z (3 months ago)
- Last Synced: 2024-11-13T14:05:05.839Z (29 days ago)
- Topics: changelog, gh-extension, golang, hacktoberfest
- Language: Go
- Homepage:
- Size: 462 KB
- Stars: 114
- Watchers: 2
- Forks: 4
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-gh-cli-extensions - **changelog** - Extension for creating changelogs that adhere to the [keep a changelog](https://keepachangelog.com/en/1.0.0/) specification. (Tool)
- jimsghstars - chelnak/gh-changelog - A gh cli extension that will make your changelogs ✨ (Go)
README
# Make your changelogs ✨
[](https://github.com/chelnak/gh-changelog/actions/workflows/ci.yml)
[](https://github.com/chelnak/gh-changelog/releases/latest)
An opinionated [GitHub Cli](https://github.com/cli/cli) extension for creating changelogs that adhere to the [keep a changelog](https://keepachangelog.com/en/1.0.0/) specification.
## What is supported?
`gh-changelog` is the tool for you if:
- You want to closely follow the [keep a changelog](https://keepachangelog.com/en/1.0.0/) specification
- You are using tags to mark releases
- You are following a pull-request workflow
## Installation and Usage
Before you start make sure that:
- GitHub Cli is [installed](https://cli.github.com/manual/installation) and [authenticated](https://cli.github.com/manual/gh_auth_login)
- You are inside a git repository
- The repository contains commits and has been pushed to GitHub
### Install
```bash
gh extension install chelnak/gh-changelog
```
### Upgrade
```bash
gh extension upgrade chelnak/gh-changelog
```
### Create a changelog
Creating changelog is simple.
Once you have installed the extension just run:
```bash
gh changelog new
```
There are also a few useful flags available.
#### --next-version
Allows you to specify the next version of your project if it has not been tagged.
```bash
gh changelog new --next-version v1.2.0
```
#### --from-version
Allows you to specify the version to start generating the changelog from.
```bash
gh changelog new --from-version v1.0.0
```
#### --latest
Creates a changelog that includes only the latest release.
This option can work well with `--next-version`.
```bash
gh changelog new --latest
```
#### Console output
You can switch between two `spinner` and `console`.
The default (`spinner`) can be overriden with the `--logger` flag.
```bash
gh changelog new --logger console
```
#### Behaviour in CI environments
If the extension detects that it is being ran in a CI environment, it will automatically switch to `console` logging mode.
This behaviour can be prevented by passing the flag `--logger spinner`.
### View your changelog
You can view your changelog by running:
```bash
gh changelog show
```
The `show` command renders the changelog in your terminal.
### Configuration
Configuration for `gh changelog` can be found at `~/.config/gh-changelog/config.yaml`.
You can also view the configuration by running:
```bash
gh changelog config
```
To print out JSON instead of YAML use `--output json` flag.
```bash
gh changelog config --output json
```
Some sensible defaults are provided to help you get off to a flying start.
```yaml
# Labels added here will be ommitted from the changelog
excluded_labels:
- maintenance
# This is the filename of the generated changelog
file_name: CHANGELOG.md
# This is where labels are mapped to the sections in a changelog entry
# The possible sections are restricted to: Added, Changed, Deprecated,
# Removed, Fixed, Security.
sections:
changed:
- backwards-incompatible
added:
- fixed
- enhancement
fixed:
- bug
- bugfix
- documentation
# When set to true, unlabelled entries will not be included in the changelog.
# By default they will be grouped in a section named "Other".
skip_entries_without_label: false
# Adds an unreleased section to the changelog. This will contain any qualifying entries
# that have been added since the last tag.
# Note: The unreleased section is not created when the --next-version flag is used.
show_unreleased: true
# If set to false, the tool will not check remotely for updates
check_for_updates: true
# Determines the logging mode. The default is spinner. The other option is console.
logger: spinner
```
You can also override any setting using environment variables. When configured from the environment,
properties are prefixed with `CHANGELOG`.
For example, overriding `check_for_updates` might look
something like this:
```bash
export CHANGELOG_CHECK_FOR_UPDATES=false
```