Include CHANGELOG.md in published npm package

[jorgeazevedo]

What does this change?

I've seen an AI agent look for the changelog in the root of the package for information about the currently installed version and why it's breaking. We include migration instructions in the release notes in the changelog, so I think this inclusion will improve agents ability to perform CDK upgrades without steering.

How to test

On main

$ npm pack --dry-run --ignore-scripts 2>&1 | wc -l 
     864
$ npm pack --dry-run --ignore-scripts 2>&1 | grep CHANGELOG
$

On this branch

$ npm pack --dry-run --ignore-scripts 2>&1 | wc -l         
     865
$ npm pack --dry-run --ignore-scripts 2>&1 | grep CHANGELOG
npm notice 50.7kB CHANGELOG.md
$

Checklist

• I have listed any breaking changes, along with a migration path ¹
• I have updated the documentation as required for the described changes ²

Footnotes

1. Consider whether this is something that will mean changes to projects that have already been migrated, or to the CDK CLI tool. If changes are required, consider adding a checklist here and/or linking to related PRs. ↩

2. If you are adding a new construct or pattern, has new documentation been added? If you are amending defaults or changing behaviour, are the existing docs still valid? ↩

[changeset-bot]

⚠️ No Changeset found

Latest commit: f7000b6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[AshCorr]

Feels pretty sensible to me!