Closed silvanocerza closed 3 days ago
Change the --include-path glob to include all files in the integration folder to track for changelog generation.
--include-path
Change the cliff.toml config file so that PRs that don't follow conventional commits appear in the changelog in a separate category.
cliff.toml
I also split CI and Chores sections.
I tested this locally. This is the before:
# Changelog ## [unreleased] ## [integrations/langfuse-v0.6.0] - 2024-11-18 ### 🚀 Features - Add support for ttft (#1161) ### ⚙️ Miscellaneous Tasks - Adopt uv as installer (#1142) ## [integrations/langfuse-v0.5.0] - 2024-10-01 ### ⚙️ Miscellaneous Tasks - Update ruff linting scripts and settings (#1105) ### Langfuse - Add invocation_context to identify traces (#1089) ## [integrations/langfuse-v0.4.0] - 2024-09-17 ### 🚀 Features - Langfuse - support generation span for more LLMs (#1087) ### 🚜 Refactor - Remove usage of deprecated `ChatMessage.to_openai_format` (#1001) ### 📚 Documentation - Add link to langfuse in LangfuseConnector (#981) ### 🧪 Testing - Do not retry tests in `hatch run test` command (#954) ### ⚙️ Miscellaneous Tasks - Retry tests to reduce flakyness (#836) - `Langfuse` - replace DynamicChatPromptBuilder with ChatPromptBuilder (#925) - Remove all `DynamicChatPromptBuilder` references in Langfuse integration (#931) ## [integrations/langfuse-v0.2.0] - 2024-06-18 ## [integrations/langfuse-v0.1.0] - 2024-06-13 ### 🚀 Features - Langfuse integration (#686) ### 🐛 Bug Fixes - Performance optimizations and value error when streaming in langfuse (#798) ### ⚙️ Miscellaneous Tasks - Use ChatMessage to_openai_format, update unit tests, pydocs (#725) <!-- generated by git-cliff -->
After:
# Changelog ## [unreleased] ## [integrations/langfuse-v0.6.0] - 2024-11-18 ### 🚀 Features - Add support for ttft (#1161) ### ⚙️ CI - Adopt uv as installer (#1142) ### 🌀 Miscellaneous - Fixed TypeError in LangfuseTrace (#1184) ## [integrations/langfuse-v0.5.0] - 2024-10-01 ### 🧹 Chores - Update ruff linting scripts and settings (#1105) ### 🌀 Miscellaneous - Fix: Add delay to flush the Langfuse traces (#1091) - Add invocation_context to identify traces (#1089) ## [integrations/langfuse-v0.4.0] - 2024-09-17 ### 🚀 Features - Langfuse - support generation span for more LLMs (#1087) ### 🚜 Refactor - Remove usage of deprecated `ChatMessage.to_openai_format` (#1001) ### 📚 Documentation - Add link to langfuse in LangfuseConnector (#981) ### 🧪 Testing - Do not retry tests in `hatch run test` command (#954) ### ⚙️ CI - Retry tests to reduce flakyness (#836) ### 🧹 Chores - `Langfuse` - replace DynamicChatPromptBuilder with ChatPromptBuilder (#925) - Remove all `DynamicChatPromptBuilder` references in Langfuse integration (#931) ### 🌀 Miscellaneous - Ci: install `pytest-rerunfailures` where needed; add retry config to `test-cov` script (#845) - Chore: Update Langfuse README to avoid common initialization issues (#952) - Chore: langfuse - ruff update, don't ruff tests (#992) ## [integrations/langfuse-v0.2.0] - 2024-06-18 ### 🌀 Miscellaneous - Feat: add support for Azure generators (#815) ## [integrations/langfuse-v0.1.0] - 2024-06-13 ### 🚀 Features - Langfuse integration (#686) ### 🐛 Bug Fixes - Performance optimizations and value error when streaming in langfuse (#798) ### 🧹 Chores - Use ChatMessage to_openai_format, update unit tests, pydocs (#725) ### 🌀 Miscellaneous - Chore: change the pydoc renderer class (#718) - Docs: add missing api references (#728) <!-- generated by git-cliff -->
We should be more careful before merging PRs and add conventional commits prefixes so the changelog is nicely formatted in the future.
Notice also that if the commit message is multiple lines those will be shown in the changelog too, but we can deal with that for the time being.
fix:
feat:
build:
chore:
ci:
docs:
style:
refactor:
perf:
test:
Related Issues
Proposed Changes:
Change the
--include-pathglob to include all files in the integration folder to track for changelog generation.Change the
cliff.tomlconfig file so that PRs that don't follow conventional commits appear in the changelog in a separate category.I also split CI and Chores sections.
How did you test it?
I tested this locally. This is the before:
After:
Notes for the reviewer
We should be more careful before merging PRs and add conventional commits prefixes so the changelog is nicely formatted in the future.
Notice also that if the commit message is multiple lines those will be shown in the changelog too, but we can deal with that for the time being.
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.