Skip to content
New issue

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

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

Already on GitHub? # to your account

[Bug]: generating a complete changelog should overwrite existing file and not commit any changes #266

Closed
1 task done
ga-paul-t opened this issue Oct 5, 2022 · 0 comments · Fixed by #270
Closed
1 task done
Assignees
Labels
bug Something isn't working triage Issue has been added to our triage list

Comments

@ga-paul-t
Copy link
Collaborator

What happened?

The uplift changelog --all command is designed to generate a complete changelog based on the current history of the repository. This is incredibly useful if migrating an existing repository to use Uplift. However, its current design doesn't quite work, as it will only generate a CHANGELOG.md:

  1. If there is no existing file. This requires a deletion that ultimately prevents the command from executing due to a dirty repository state
  2. It generates a commit which may not include a version number and can produce a confusing git history

This command should be treated as a utility function that updates the existing CHANGELOG.md in situ and requires the user to handle the modified file manually

Steps to reproduce it

  1. Clone an existing repository with a CHANGELOG.md file and run uplift changelog --all

Your uplift configuration

No response

Which version?

v2.17.0

Which operating system(s) are you using?

All

Optional debug output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@ga-paul-t ga-paul-t added bug Something isn't working triage Issue has been added to our triage list labels Oct 5, 2022
@ga-paul-t ga-paul-t self-assigned this Oct 5, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
bug Something isn't working triage Issue has been added to our triage list
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant