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

Improve clarity on changelog command "--range" argument in a situation where I have two git commit hashes #315

Open
gfargo opened this issue Dec 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@gfargo
Copy link
Owner

gfargo commented Dec 11, 2024

Describe the Issue
The other day, I wanted to generate a changelog for a large collection of commits. Despite having the commit hash for the start and end of the range, I found myself struggling to use the --range flag with the changelog command to generate a changelog.

In the end, I just ended up going a slightly different, less accurate, way via

coco changelog -r HEAD~36:HEAD

To Reproduce
Steps to reproduce the behavior:

  1. Run the coco changelog command
  2. Pass --range or -r parameters with two git commits
  3. What format should I be using when passing commits v.s. referencing HEAD 💭

Expected behavior
Maybe we can include a better description in the help output for this command, with more examples?

Screenshots

Screenshot 2024-12-11 at 1 19 09 PM

Desktop:

  • OS: MacOS
  • Shell: ZSH
  • Version: 0.14.8
@gfargo gfargo added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Dec 11, 2024
@gfargo gfargo changed the title Not entirely clear how to use changelog command --range argument in a situation where I have two git commit hashes Improve clarity on changelog command "--range" argument in a situation where I have two git commit hashes Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant