# Pinned Dependency Upgrade-Range Breaking-Change Brief (`kingii98/pinned-dependency-upgrade-range-breaking-change-brief`) Actor

For each pinned npm or PyPI package, read the GitHub release notes between the pinned and target version and list breaking and removed items with quoted source text.

- **URL**: https://apify.com/kingii98/pinned-dependency-upgrade-range-breaking-change-brief.md
- **Developed by:** [kingii98](https://apify.com/kingii98) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$10.00 / 1,000 package range analyseds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## 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 .
```

# Actor input Schema

## `packages` (type: `array`):

Packages to check. Maximum 100. Each item has ecosystem (npm or PyPI), name, pinnedVersion, and optional targetVersion. Without targetVersion, the latest registry version is used.

## `githubToken` (type: `string`):

Optional token for a higher GitHub API rate limit. Not stored in the output.

## `maxConcurrency` (type: `integer`):

Number of parallel HTTP requests. From 1 to 10.

## Actor input object example

```json
{
  "packages": [
    {
      "ecosystem": "PyPI",
      "name": "requests",
      "pinnedVersion": "2.30.0",
      "targetVersion": "2.32.0"
    },
    {
      "ecosystem": "npm",
      "name": "express",
      "pinnedVersion": "4.18.0",
      "targetVersion": "5.0.0"
    }
  ],
  "maxConcurrency": 5
}
```

# Actor output Schema

## `results` (type: `string`):

Verdict, breaking items, and removed items for each package.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "packages": [
        {
            "ecosystem": "PyPI",
            "name": "requests",
            "pinnedVersion": "2.30.0",
            "targetVersion": "2.32.0"
        },
        {
            "ecosystem": "npm",
            "name": "express",
            "pinnedVersion": "4.18.0",
            "targetVersion": "5.0.0"
        }
    ],
    "maxConcurrency": 5
};

// Run the Actor and wait for it to finish
const run = await client.actor("kingii98/pinned-dependency-upgrade-range-breaking-change-brief").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "packages": [
        {
            "ecosystem": "PyPI",
            "name": "requests",
            "pinnedVersion": "2.30.0",
            "targetVersion": "2.32.0",
        },
        {
            "ecosystem": "npm",
            "name": "express",
            "pinnedVersion": "4.18.0",
            "targetVersion": "5.0.0",
        },
    ],
    "maxConcurrency": 5,
}

# Run the Actor and wait for it to finish
run = client.actor("kingii98/pinned-dependency-upgrade-range-breaking-change-brief").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "packages": [
    {
      "ecosystem": "PyPI",
      "name": "requests",
      "pinnedVersion": "2.30.0",
      "targetVersion": "2.32.0"
    },
    {
      "ecosystem": "npm",
      "name": "express",
      "pinnedVersion": "4.18.0",
      "targetVersion": "5.0.0"
    }
  ],
  "maxConcurrency": 5
}' |
apify call kingii98/pinned-dependency-upgrade-range-breaking-change-brief --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,kingii98/pinned-dependency-upgrade-range-breaking-change-brief"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/302d3hZpP9mQhnyl0/builds/6BoDk5cdQJ6G9u1hn/openapi.json