thesylence / changey

Manage your changelogs

Hi there 👋

changey's Issues

New verb: Extract changes of a specific version

changey extract 1.2.3 should extract all sections of the version 1.2.3 into a new file.

This file than can be used to indicate changes of a single release (e.g. in a github release)

Split commands

Option classes should only hold options and then be passed to a command that executes its logic based on these options

Add readme to nuget package

https://docs.microsoft.com/en-us/nuget/nuget-org/package-readme-on-nuget-org

Version links

Allow user to define links for changelog versions

These are defined at the bottom of the changelog like the following:

[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0
[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2
[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1

Default option to section add

Allow the user to omit the "-m" when adding a section.

changey add "My message" instead of changey add -m "My message"

Display correct version

The released tool display version 1.0.0 when invoked via changey version

Add integration test

Add an integration test as part of the CI workflow

• init new changelog
• add message to section
• release version
• add another message
• release version
• yank version

Verify changelog content after each step

Unreleased version at bottom of changelog

The current unreleased version is written to the bottom of the changelog instead of the top.

Default option for release name

Allow the user to omit the "-n" when releasing a version.

changey release 1.2.3 instead of changey release -n 1.2.3

Init overrides files

Do not overwrite file unless a force option is specified

Add Verbs to add changes to the changelog

As a user I want to be able to add a new change to a section of the changelog.

Add/Fixes/Deprecated/etc should be their own verbs.
e.g. changey fix MESSAGE

Add support for more versioning schemes

Add support for calver and maybe other versioning schemes.
Change semver option to a "scheme" option that takes the scheme.

e.g. -scheme none or -scheme semver, ...

Hide exception stacktraces

Unless verbose logging is enabled hide stack traces of exceptions and only display messages

Warn when releasing older version

Warn when a changey release is invoked with a version that is lower than the latest released version in the changelog.

Example:
[1.2.3] - 2021-07-21
changelog content

Invoke changey release 1.1.2

Output:
Version 1.1.2 is older than latest released version (1.2.3). Specify flag to force release

Add examples to verbs

Verbs can have examples that are displayed on the help screen.
Add some for every verb.

Tests for Commands

As a developer I want to have UnitTests for the Commands that are used as verbs.

To do so the needed Services needs to be injected using a constructor that is not used by the CommandLineParser library

Adding to sections fails after first release

When a first version is released adding to sections fails because there is no unreleased version.
Create one implicitly

Yank command

Implement command to yank last released version