Get release notes
get_release_notesGet release notes. Use this when the user asks what changed between two versions of a package, or what to watch for in an upgrade, such as "what changed in express between 4.18.2 and 5.1.0?" or "are there breaking changes from requests 2.28 to 2.32?". Pass the npm or PyPI package name (or a GitHub repo) and fromVersion, the version the user has; toVersion defaults to the latest release. Returns each release after fromVersion up to toVersion, newest first, with its date, link, a short excerpt of its notes and a breaking flag, plus a GitHub compare link. Notes come from GitHub releases and, when those do not reach back far enough, from the repository's changelog file; complete is false when neither covers the whole range. Not for vulnerabilities.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Public package name, such as "express" or "requests". Its latest release names the GitHub repository. | |
| repo | No | A GitHub repository instead of, or with, a package name: "owner/repo" or its github.com url | |
| ecosystem | No | npm (the default) or pypi; used with name | |
| toVersion | No | The version to upgrade to; the package's latest release when left out | |
| fromVersion | Yes | The version you have now, such as 4.18.2. Notes start after it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asOf | Yes | ||
| name | No | ||
| error | No | ||
| notice | Yes | ||
| source | Yes | ||
| status | Yes | ||
| complete | No | False when the newest 10 GitHub releases and the changelog do not reach back to fromVersion | |
| releases | No | Releases after fromVersion up to toVersion, newest first | |
| ecosystem | No | ||
| toVersion | No | ||
| compareUrl | No | ||
| repository | No | ||
| fromVersion | Yes | ||
| changelogUrl | No | ||
| releaseCount | No | ||
| omittedVersions | No | Older releases in the range left out to keep the answer short | |
| breakingVersions | No |