Skip to content

Conversation

jonathan343
Copy link
Contributor

Summary

This PR adds a new "dependency" changelog type to the project's changelog management system. This allows changelog
entries to be categorized specifically for dependency updates, which are distinct from features, enhancements,
bugfixes, and breaking changes.

The changes include:

  • Added "dependency" as a valid changelog type option in the new-entry.py script.
  • Modified the PACKAGE changelog template to include a "Dependencies" section that appears after bug fixes.

This enhancement provides better organization for changelogs by separating dependency updates from other types of
changes, making it easier for users to track what dependencies have been updated in each release.

Testing

  • Verify that the new-entry.py script accepts the new "dependency" type:
    ./scripts/changelog/new-entry.py -p smithy-core -t dependency -d "Test dependency entry"
  • Run new-release.py to ensure dependency entries are sorted correctly and appear in the expected order (after
    bugfixes)
    ./scripts/changelog/new-release.py -p smithy-core -v 1.2.3
  • Check that the PACKAGE template renders dependency sections correctly with existing changelog entries
    ./scripts/changelog/render.py -p smithy-core

Output:

# Changelog

## v1.2.3

### Dependencies
* Test dependency entry

... 

<Older Version Entries>

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jonathan343 jonathan343 requested a review from a team as a code owner October 17, 2025 19:52
Copy link

@ubaskota ubaskota left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jonathan343 jonathan343 merged commit ee04163 into develop Oct 20, 2025
6 checks passed
@jonathan343 jonathan343 deleted the add-dependency-changelog-type branch October 20, 2025 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants