Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: very_good changelog #385

Open
orestesgaolin opened this issue May 10, 2022 · 0 comments
Open

feat: very_good changelog #385

orestesgaolin opened this issue May 10, 2022 · 0 comments
Labels
feature A new feature or request p3 Issues that we currently consider unimportant

Comments

@orestesgaolin
Copy link

Description

As part of the CLI it would be super convenient to have changelog action that would generate a simple changelog, similar to conventional-changelog.

Below you'll find some examples of how I imagine this to work. There would be ways to:

  • set start and end commit, start-at would be either a required parameter to not handle this logic, or by default would grab the whole history
  • set format (plain-text, markdown, json?)
  • include types of commits
  • group entries by type
  • scope the changelog using conv-commits scope

Nice to have:

  • grouping the entires by tags e.g. if there are 0.0.1, 0.0.2, 1.0.0, 2.0.0 then this would be 4 sections in the changelog

Usage

very_good changelog --start-at bfed91f6 --end-at f8a987b3 --scope my_package --format plain-text

Expected output

feat(my_package): add some cool feature (2022-05-11)
fix(my_package): don't cause this super annoying crash (2022-05-10)
refactor(my_package): improve doing this small thing (2022-05-01)

note: this is similar to command: git log --pretty="%s (%as)" $PREVIOUS_COMMIT...HEAD


very_good changelog --include feat,fix,refactor,chore,ci --start-at bfed91f6 --format markdown

Expected output

- chore: fix formatting [(2022-05-12)](https://github.com...)
- feat(my_package): add some cool feature [(2022-05-11)](https://github.com...)
- ci: improve the build process [(2022-05-11)](https://github.com...)
- fix(my_package): don't cause this super annoying crash  [(2022-05-11)](https://github.com...)
- fix(other_package): change  [(2022-05-11)](https://github.com...)
- refactor(my_package): improve doing this small thing  [(2022-05-11)](https://github.com...)

very_good changelog --start-at bfed91f6 --format markdown --group true

Expected output

## Features

- add some cool feature to the app [(2022-05-11)](https://github.com...)
- **my_package**: add some cool feature [(2022-05-11)](https://github.com...)

## Bug fixes

- **my_package**: don't cause this super annoying crash  [(2022-05-11)](https://github.com...)
- **other_package**: change how something is handled [(2022-05-11)](https://github.com...)

# Refactorings

- **my_package**: improve doing this small thing  [(2022-05-11)](https://github.com...)
@orestesgaolin orestesgaolin added feature A new feature or request feedback wanted labels May 10, 2022
@tomarra tomarra added the p3 Issues that we currently consider unimportant label Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature or request p3 Issues that we currently consider unimportant
Projects
Status: Backlog
Development

No branches or pull requests

2 participants