Pinned Dependency Upgrade-Range Breaking-Change Brief

This Actor helps you decide if a dependency upgrade is safe to merge. For each pinned npm or PyPI package, it reads the GitHub release notes between the pinned version and the target version. It lists breaking items and removed items. Each item has its source URL and quoted text.

Input

Field	Type	Description
packages	array (maximum 100)	Items with ecosystem (npm or PyPI), name, pinnedVersion, and optional targetVersion.
githubToken	secret string, optional	Gives a higher GitHub API rate limit.
maxConcurrency	integer, 1 to 10	Parallel HTTP requests. Default 5.

Empty input runs the default example (two packages). Without targetVersion, the Actor uses the latest registry version.

Output

One dataset row for each package:

• package, ecosystem, pinned_version, target_version
• versions_in_range: stable versions above the pinned version, up to the target version.
• breaking_items and removed_items: each has version, source_url, and quote.
• verdict: breaking notes found, no breaking notes found, or release notes not found.
• reason: the cause of a release notes not found verdict, or null.

A bad input item or a failed lookup gives a release notes not found row. The run does not fail.

How it works

1. Read the version list and the repository URL from the npm or PyPI registry.
2. Find the versions in the range.
3. Read up to 10 pages of GitHub Releases for the repository.
4. Match release tags to the versions. Find items under "breaking" or "removed" headings, and lines with breaking or removal keywords.

No browser, proxy, or language model is used. The Actor sends HTTPS requests only to registry.npmjs.org, pypi.org, and api.github.com. It rejects all other targets, and limits redirects, response size, and time.

Pricing events (pay per event)

Event name	When the Actor charges it	Price
package-range-analysed	One time for each package upgrade range that is analysed.	USD 0.01

The Actor does not charge a package with the verdict release notes not found. It does not charge a rejected input item. It stops when the maximum charge limit is reached.

Limits

• Only GitHub Releases are a source. Packages without GitHub Releases give release notes not found.
• Classification uses headings and keywords. It can miss items or find false items.
• In a monorepo, only tags that match the package name or have no prefix are matched.

Development

uv run pytest
uv run ruff check .