masynchin / change-a-changelog

Make changes to your changelog easily

¡Yahoo! 🥳

I am a little pogrommer from Cherepovets, studying at SPbU.

I mostly write in Python, but also interested in Scala, Rust, and PureScript.

Here is the list of some of my projects:

• ⛅ CheWeatherBot - Telegram-bot about weather in my hometown.
• 📋 Ndnt - CLI-tool to inspect indentation of your files.
• 💬 Textode - Library which makes creating stateless-dialog systems easy.

I am currently working at:

• 🎲 Three - 3D version of Tic-Tac-Toe.
• 📝 Change-a-Changelog - CLI-tool for editing a changelog.

You can read history of all my repositories here (in Russian).

change-a-changelog's Issues

Release action

First version is published by myself, and now we need to make this automatically.

Proposed design

Each GitHub release should trigger this action, and this action should upload new version with release's tag to crates.io.

Command to create basic changelog

It must be a command to create basic changelog.

Proposed design

change new

This command must generate basic CHANGELOG.md with the following content:

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

Add command

It must be a command to add changes.

Proposed design

The command to add changes can look like this:

changes add <text>

Where <text> is the text of added changes. For example:

changes add 'Command to append changes to the latest version'

This command should add changes to the latest version. For now, it is Unreleased. After command

changes add 'Command to append changes to the latest version'

The newly create Changelog should be this:

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

- Command to append changes to the latest version

[Unreleased]: https://github.com/<owner>/<repo>/compare/0.1.0..HEAD