https://github.com/javierav/changefu
A command-line utility that help you to keep a good changelog
https://github.com/javierav/changefu
changelog changelog-generator cli command-line-tool keepachangelog ruby
Last synced: 10 months ago
JSON representation
A command-line utility that help you to keep a good changelog
- Host: GitHub
- URL: https://github.com/javierav/changefu
- Owner: javierav
- License: mit
- Created: 2019-11-11T10:23:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-04T07:27:56.000Z (over 6 years ago)
- Last Synced: 2025-08-31T08:59:12.831Z (10 months ago)
- Topics: changelog, changelog-generator, cli, command-line-tool, keepachangelog, ruby
- Language: Ruby
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changefu.gemspec
- License: LICENSE
Awesome Lists containing this project
README
# ChangeFu
> A command-line utility that help you to keep a good changelog.
## Table of Contents
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Configuration](#configuration)
- [Available Commands](#available-commands)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)
## Installation
```bash
$ gem install changefu
```
## Getting Started
1. Run setup command to add the configuration to project:
```
$ changefu setup
create changelog
create changelog/releases
create changelog/unreleased
create changelog/releases/.keep
create changelog/unreleased/.keep
create changelog/releases.yml
create .changefu.yml
```
2. Add a changelog entry
```
$ changefu add "Fix user login" --type fixed
create changelog/unreleased/20200210122512_fix_user_login.yml
```
3. Generate the changelog
```
$ changefu generate
created CHANGELOG.md
```
## Configuration
```
TODO: Write configuration guide
```
## Available Commands
```
TODO: Write list of available commands
```
### setup
```
$ changefu setup
```
### add
```
$ changefu add "Show user status in user list table" --type changed --issue 4466 --username javierav
```
### release
```
$ changefu release 1.0.0 --date 2020-02-10 --skip-generate --tag v1.0.0
```
### generate
```
$ changefu generate
```
## Testing
```
TODO: Write testing instructions
```
## Contributing
Contributions are welcome, please follow [CONTRIBUTING.md](CONTRIBUTING.md) guide.
## License
Copyright (c) 2020 Javier Aranda - Released under [MIT](LICENSE) license.