Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changed?
This PR introduces towncrier to manage the AgentKit.py changelogs. While
towncrier
can support a monorepo setup, we currently do not treat the Python packages as a monorepo, so I decided to introducetowncrier
to each Python package individually.The following
towncrier
config options are modified:Why?
Contributors can add independent changelog entries without having to worry about or deal with merge conflicts.
Maintainers can generate full changelogs with one command.
The intended contribution workflow is:
poetry run towncrier create
from the package folder with appropriate options to write a changelog entryfeature
orbugfix
(these are two of towncriers default types, and change content should be in past tense (e.g. "Added new feature", "Fixed the bug")The release workflow is:
poetry run towncrier
which will consume changelog entries in.changelog.d/
and append to theCHANGELOG.md
Next steps