# GitHub Release Watch – Breaking Changes Since Your Version (`petipeti/github-release-watch`) Actor

Schedule it daily for the repositories you depend on: new releases since your version, major bumps, and breaking-change lines pulled out of the release notes. Handles monorepo tags and backports correctly.

- **URL**: https://apify.com/petipeti/github-release-watch.md
- **Developed by:** [peti peti](https://apify.com/petipeti) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $2.00 / 1,000 repository checkeds

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

## GitHub Release Watch – Breaking Changes Since Your Version

**"Is it safe to upgrade?" – answered every morning for every library you depend on.**

List the GitHub repositories you rely on, optionally with the version you use, and schedule this Actor daily. For each one you get:

- **status**: `up-to-date`, `update`, or `breaking-update`
- **how far behind you are** (`releasesBehind`) and whether the latest is a **major upgrade**
- **breaking-change lines pulled out of the release notes** of every release since your version: "Breaking changes" sections plus lines like *dropped support for Node 18*, *`legacy` option removed*, *破壊的変更*
- the new releases with links

### Gets the tricky cases right

- **Backports**: `v6.4.5` published after `v8.3.5` is not "the latest" – versions are compared, not dates.
- **Monorepos**: tags like `create-vite@9.3.1` next to `v8.3.5` are kept apart; pick a package with `owner/repo:package@version`.
- **Drafts and pre-releases** are skipped (pre-releases optional).
- Without `@version`, each new release is reported **once** (remembered in a named key-value store), so a daily run is quiet when nothing happened.

### Input

```json
{
  "repositories": ["vitejs/vite@7.1.0", "nodejs/node", "vitejs/vite:create-vite@8.0.0"],
  "githubToken": "<optional, your own token>"
}
```

A token is optional but recommended: without one GitHub allows 60 requests per hour per IP address, and cloud IPs are shared. A fine-grained token with no permissions is enough for public repositories.

### Output (one row per repository line)

```json
{
  "repository": "vitejs/vite",
  "package": null,
  "status": "breaking-update",
  "currentVersion": "7.1.0",
  "latestVersion": "8.3.5",
  "releasesBehind": 44,
  "majorUpgrade": true,
  "breakingNotes": ["8.0.0: drop Node 18", "8.3.4: remove input option unescaping for now (#23694)"],
  "latestUrl": "https://github.com/vitejs/vite/releases/tag/v8.3.5",
  "newReleases": [{ "tag": "v8.3.5", "version": "8.3.5", "published": "2026-10-21T06:35:46Z", "majorBump": false, "breakingNotes": [] }]
}
```

Breaking-change detection reads the release notes on GitHub. Projects that only write "see CHANGELOG.md" still get the major-version flag, but no extracted lines.

### Fair use

Uses the official GitHub REST API – one request per repository – under GitHub's API terms. Only release data is read; no user profiles or personal information are collected (release authors are not included).

### Pricing

Pay per event, platform usage included:

| Event | Price |
|---|---|
| Actor start | $0.01 per run |
| `repo-checked` – one repository line checked | $2.00 per 1,000 ($0.002 each) |

Example: 20 dependencies checked daily ≈ 30 × ($0.01 + 20 × $0.002) = **$1.50 per month**. Errors (not found, rate limit) are free.

### 日本語での説明

使っているライブラリの GitHub リポジトリを毎日見張り、自分のバージョンより新しいリリース、メジャーアップデートかどうか、リリースノートから抜き出した「破壊的変更」の行を知らせます。古い版の修正リリース（バックポート）を「最新」と取り違えたり、モノレポの別パッケージのタグが混ざったりしないように、日付ではなくバージョン番号で比べます。公式の GitHub API を使い、個人情報は扱いません。

料金: 1回 $0.01 ＋ 1リポジトリ $0.002。

# Actor input Schema

## `repositories` (type: `array`):

One per line: owner/repo (or its GitHub URL). Add @version to compare with the version you use: vitejs/vite@7.1.0. For monorepos pick the package: vitejs/vite:create-vite@8.0.0.

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

Your own personal access token (no scopes needed for public repos). Without it GitHub allows 60 requests per hour per IP, which shared cloud IPs can run out of. Stored encrypted; used only for the GitHub API in your run.

## `includePrereleases` (type: `boolean`):

Also report alpha / beta / rc releases.

## `stateStoreName` (type: `string`):

Named key-value store in your account. Used for lines without @version, so each new release is reported once.

## Actor input object example

```json
{
  "repositories": [
    "vitejs/vite@7.1.0"
  ],
  "includePrereleases": false,
  "stateStoreName": "github-release-watch-state"
}
```

# Actor output Schema

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

One row per repository line: status, latest version, releases behind, major upgrade, breaking-change notes and the new releases.

# 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 = {
    "repositories": [
        "vitejs/vite@7.1.0"
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("petipeti/github-release-watch").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 = { "repositories": ["vitejs/vite@7.1.0"] }

# Run the Actor and wait for it to finish
run = client.actor("petipeti/github-release-watch").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 '{
  "repositories": [
    "vitejs/vite@7.1.0"
  ]
}' |
apify call petipeti/github-release-watch --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,petipeti/github-release-watch"
        }
    }
}
```

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/yPaf1TraMEKXCVBAe/builds/mL23ueJ10LN8TBbMI/openapi.json