deepset-ai / deepset-ai/haystack-core-integrations
Changelog generation - weaknesses and possible improvements
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 203
- Forks
- 332
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 80
Description
In README, we say
To ensure the changelog is accurate, it's recommended to tag a commit that includes the actual changes for the integration (usually the PR merge commit). Tagging a commit that doesn't contain those changes can lead to an incorrect changelog.
This approach is problematic because multiple people might merge commits into main at the same time.
Additionally, tagging any commit other than the latest one on main causes changelog generation to fail. - UPDATE: this might have been fixed in https://github.com/deepset-ai/haystack-core-integrations/pull/2742
While manual editing is always possible, once an incorrect changelog is introduced, the error persists and doesn't go away automatically.
Requires investigation. It might be a difficult fix.
(@sjrl)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the changelog guidance in README and the possible fix discussed in pull request #2742. Investigate how concurrent merges and tags that are not the latest commit affect generation, and determine how an incorrect changelog could be corrected automatically. Done means the failure modes are understood and a concrete fix scope is established.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- release
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100