# GitHub Release Asset Contract Monitor (`quietdatatools/github-release-asset-contract-monitor`) Actor

Monitor exact-tag GitHub release assets for replacements, metadata and reported checksum changes. Persistent before/after history and required download filename checks.

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

## Pricing

$10.00 / 1,000 successful asset metadata checks

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 Asset Contract Monitor

Keep an exact-tag download contract under observation. Check a **public GitHub release** for assets added, changed or removed after publication, and report missing filenames your installer or distribution workflow expects. History persists in Apify, so you do not supply a previous release record on every run.

### Who it helps

Release engineers, package distributors and teams depending on a particular upstream release can watch asset IDs, names, labels, sizes, MIME types, download URLs and GitHub-reported digests. A replacement upload with the same filename has a new asset ID and is reported as an addition plus a removal. This checks metadata without downloading binaries.

### Input

```json
{
  "repository": "cli/cli",
  "tag": "v2.78.0",
  "monitorName": "github-cli-downloads",
  "requiredAssets": ["gh_2.78.0_linux_amd64.tar.gz"],
  "includeUnchanged": true
}
```

- `repository`: a public `owner/repository` on github.com. No private repositories or tokens.
- `tag`: exact release tag, **not latest**. Keep it stable across checks.
- `monitorName`: independent baseline name. Use the same name to compare subsequent runs. Different users, Actors, repositories and tags have independent history.
- `requiredAssets`: exact, case-sensitive asset filenames. Missing names are reported in the summary, including on the first check.
- `includeUnchanged`: emit `UNCHANGED` asset rows on repeat checks (default true).

### Output

The dataset contains `BASELINE`, `ADDED`, `CHANGED`, `REMOVED` and optionally `UNCHANGED` rows with asset ID, name, changed properties, previous/current metadata, repository, tag, release ID and check time. The `OUTPUT` key-value record reports counts, missing required assets, digest coverage and any prerelease-state change. If a release has no assets or unchanged rows are suppressed, a successful check can have an empty dataset; consult the summary.

An asset's download count and timestamps alone do not trigger a change. GitHub's optional `digest` is recorded as reported; a null digest means unavailable. **The Actor does not independently verify file integrity, detect byte changes when GitHub metadata does not change, or guarantee an upstream release is safe.** It does not fetch source archives or binaries.

### Persistent checks and failure behavior

The first successful check establishes a baseline. Later successful checks compare with the last committed snapshot. HTTP errors, API quota limits, incomplete responses, duplicate assets, unfinished uploads and unsupported metadata fail without advancing the committed snapshot. Failed source checks are not charged the `asset-check` event. A tag unexpectedly pointing to a different release ID fails; choose a new monitor name to explicitly establish a new baseline.

Public unauthenticated GitHub REST calls are subject to GitHub's shared-IP rate limits (normally 60 requests/hour/IP). Each check makes two bounded metadata requests. This Actor does not retry quota errors, request credentials or use paid proxies. A check can fail when Apify's egress IP has exhausted its GitHub allowance; try later. Maximum supported assets per release: **99**. A 100-item response is conservatively rejected rather than risking false removals from pagination. Each response is capped at 2 MB, each request at 20 seconds. The two responses are sequential observations, not an atomic GitHub snapshot.

Run one check at a time per monitor. A best-effort lease reduces overlap but is not an atomic lock. On an abort, the committed history is preserved; a lease can take five minutes to expire. Dataset output and successful-check billing precede snapshot commit; interruptions can leave output without a new committed baseline. Delivery is at least once, not exactly once. Required-asset changes do not change the source identity.

### Pricing

**$0.01 per successful asset metadata check.** Baseline and unchanged checks count. One event per successful check, regardless of asset count, with platform usage included in this pay-per-event price. There is no per-asset, per-download or startup charge. A missing required filename on a complete source response is a successful billed check. No guarantee of demand, revenue or continuous upstream availability.

### Scheduling

Use an Apify schedule with the same input and monitor name. Start with infrequent checks to respect GitHub limits. Use dataset/summary exports or your own integrations to handle alerts; this Actor does not send email or messages itself.

# Actor input Schema

## `repository` (type: `string`):

owner/repository on github.com; public releases only, no tokens.

## `tag` (type: `string`):

Exact public release tag; not latest.

## `monitorName` (type: `string`):

Keep this name for repeat checks.

## `requiredAssets` (type: `array`):

Exact case-sensitive asset names; missing names appear in the summary.

## `includeUnchanged` (type: `boolean`):

Write UNCHANGED asset rows for successful repeat checks.

## Actor input object example

```json
{
  "repository": "cli/cli",
  "tag": "v2.78.0",
  "monitorName": "default",
  "requiredAssets": [],
  "includeUnchanged": true
}
```

# Actor output Schema

## `assets` (type: `string`):

No description

## `summary` (type: `string`):

No description

# 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 = {
    "repository": "cli/cli",
    "tag": "v2.78.0"
};

// Run the Actor and wait for it to finish
const run = await client.actor("quietdatatools/github-release-asset-contract-monitor").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 = {
    "repository": "cli/cli",
    "tag": "v2.78.0",
}

# Run the Actor and wait for it to finish
run = client.actor("quietdatatools/github-release-asset-contract-monitor").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 '{
  "repository": "cli/cli",
  "tag": "v2.78.0"
}' |
apify call quietdatatools/github-release-asset-contract-monitor --silent --output-dataset

```

## MCP server setup

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

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/pinKRl7SKvEbdFhQa/builds/lf1lPHx6geiv50ZUT/openapi.json