search

di-sukharev / opencommit

Generate conventional git commit messages with AI in 1 second 🤯🔫
https://www.npmjs.com/package/opencommit
MIT License
6.15k stars 328 forks source link

[Feature]: #175

Open masterkain opened 1 year ago

masterkain commented 1 year ago

Description

I'm using release please which has its way to parse commits for changelog: https://github.com/googleapis/release-please/tree/main#what-if-my-pr-contains-multiple-fixes-or-features

do you think we can modify the prompt to emit this kind of structured output?

Suggested Solution

modify the prompt to emit this kind of structured output

Alternatives

No response

Additional Context

No response

di-sukharev commented 1 year ago

i dont undertand you bro :)

masterkain commented 1 year ago

I'll try to explain myself better

https://github.com/icoretech/airbroke/commits/main

as you can see I'm using opencommit for the vast majority of the commits.

there are github actions, such as this one (https://github.com/icoretech/airbroke/blob/main/.github/workflows/generate-release.yml#L16) that can generate a changelog (and even determine version bumps) by looking at the opencommits done between tags.

however as you can also see it's kinda hit and miss: https://github.com/icoretech/airbroke/compare/v1.1.12...v1.1.13

expand the first commit and you'll see that the description is gigantic, but it's not making its way into the changelog.

so I found the page I linked in the original ticket https://github.com/googleapis/release-please/tree/main#what-if-my-pr-contains-multiple-fixes-or-features that explains the kind of format that this github action wants in order for the commit to be parsed correctly and make it into the changelog.

github-actions[bot] commented 1 year ago

Stale issue message