search

BobAnkh / auto-generate-changelog

A Github Action to generate CHANGELOG automatically according to conventional commits. Feel free to contribute!
Apache License 2.0
80 stars 22 forks source link

[bug] using the pull request config removes every other changelog entry #82

Closed mmattbtw closed 2 years ago

mmattbtw commented 2 years ago

Describe the bug

When pushing a new update, the workflow updates the the current update, but then removes the other entries.

To Reproduce

NOTE:Self-contained, minimal reproducing samples are extremely helpful and will expedite addressing your issue

Steps to reproduce the behavior:

  1. Make an update
  2. Wait for workflow to update changelog
  3. Observe

Expected behavior

It shouldn't delete the other entries, and should only update that current update

Screenshots

https://github.com/mmattDonk/AI-TTS-Donations/pull/155/files

(backup screenshots just in case that pr changes) image image image

Environment

https://github.com/mmattDonk/AI-TTS-Donations/blob/main/.github/workflows/changelog.yml

gitmagic-app[bot] commented 2 years ago

Everything looks good :thumbsup:

gitmagic-app[bot] commented 2 years ago

Everything looks good :thumbsup:

BobAnkh commented 2 years ago

Hello, I don't understand what do you mean by should only update the current update?

Could you please give a simple example of what do you expect and what this workflow gives? Or what shouldb't be done within the workflow?

mmattbtw commented 2 years ago

@BobAnkh By "current update" I mean the commit/pull request/tag that isn't already on the Changelog, that is being updated by the workflow. So when I commit "feat(core): added feature", the change log updated with that commit, that would be the "current update".

What the workflow shouldn't do (what it's doing in my case) is delete every other update information.

BobAnkh commented 2 years ago

@mmattbtw Hi, do you mean an incremental changelog? For example, when you push a new commit, then only add this commit into your current changelog, not affecting the remaining content? If this is what you are talking about, then I'm afraid it is not supported yet and this should not be concerned as a bug.

I'm generate the changelog release/tag by release/tag, and I'm planning to support the feature that only re-generate the last several releases though, for performance purpose. However, this feature may not come soon. And also in this feature, I will take release as the minimal unit to generate, not commit. It is very hard to add only new commits that not include in the changelog.

BobAnkh commented 2 years ago

@mmattbtw

The problem should be partially alleviated in the new release v1.2.1 with incremental changelog generation implemented.

github-actions[bot] commented 1 year ago

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue.