# Software Release and Advisory Ledger (`flintglade/software-release-advisory-ledger`) Actor

Track public GitHub software releases and security advisories with canonical evidence, durable baselines, and deterministic change ledgers.

- **URL**: https://apify.com/flintglade/software-release-advisory-ledger.md
- **Developed by:** [Flintglade](https://apify.com/flintglade) (community)
- **Categories:** Automation, Developer tools, Other
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $30.00 / 1,000 repository checks

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

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

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.
Actors are written with capital "A".

## 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.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Software Release and Advisory Ledger (AP-026)

AP-026 turns official GitHub repository, release, and repository-security-advisory data into a deterministic evidence snapshot and, when a persistent baseline store is supplied, an explicit change ledger. It is designed for evidence monitoring—not release recommendation, dependency scanning, exploitability analysis, or generic scraping.

### What one repository check does

For each public `owner/name`, the Actor reads only fixed official GitHub REST paths:

- repository metadata;
- the configured newest release window; and
- the configured newest repository security-advisory window.

The Actor projects bounded factual fields, sorts them canonically, stores an exact canonical JSON evidence artifact, and emits `baseline_created`, `unchanged`, or `changed`. Change events distinguish repository metadata, added/updated/window-removed releases, and added/updated/withdrawn/window-removed advisories. A removal is never claimed when either compared window is truncated.

### Input

```json
{
  "repositories": [{"owner": "psf", "name": "requests"}],
  "baselineStoreId": "optional-persistent-kv-store-id",
  "includePrereleases": true,
  "includeDrafts": false,
  "releaseLimit": 100,
  "advisoryLimit": 100,
  "concurrency": 5
}
```

Inputs are capped at 100 unique repositories. Arbitrary URLs are rejected. Public checks need no secret. An optional `GITHUB_TOKEN` Actor environment secret can raise GitHub rate limits; it is never accepted in Actor input, echoed, or stored.

### Output and deterministic evidence

The default dataset contains one result per requested repository plus one uncharged run summary. A chargeable result points to an `EVIDENCE_*.json` key-value-store record and includes its exact byte length and SHA-256. `ARTIFACT_MANIFEST.json` inventories successfully charged evidence artifacts. Snapshot bytes exclude run IDs, timestamps, and response headers, so identical source projections produce identical bytes and hashes.

With `baselineStoreId`, the Actor journals a candidate before output, emits the evidence artifact, then uses Apify's charged dataset push. The baseline becomes current only after that durable charged output reports one charged event. Recovery completes a charged-but-not-yet-committed journal on a later run.

### Billing

The pay-per-event event is `repository-check` at the portfolio-planned price of **$0.03 per terminal repository check**. Only `baseline_created`, `unchanged`, and `changed` are chargeable. Invalid input, source/rate-limit/authorization errors, artifact or baseline failures, and charge-limit placeholders are uncharged. The Actor asks the charging manager for the available event count before scheduling work and never intentionally starts more checks than that budget admits.

### Limits and interpretation

- GitHub is the sole source; an absent advisory is not evidence that no vulnerability exists elsewhere.
- Release and advisory windows are newest-first and capped at 500 each. Truncation is explicit.
- GitHub fields are publisher-maintained. AP-026 does not independently verify release contents, CVEs, severity, affected ranges, or patches.
- Draft visibility depends on caller authorization; unauthenticated public checks normally return only public records.
- Repository `updated_at` and `pushed_at` are tracked as factual metadata and may produce metadata-only changes.

See [SOURCE\_POLICY.md](SOURCE_POLICY.md), [PRIVACY.md](PRIVACY.md), and [THREAT\_MODEL.md](THREAT_MODEL.md) for operational boundaries.

### Local verification

From the repository root, with the repository development environment active:

```text
python -m pytest -q actors/ap-026-software-release-advisory-ledger/tests
python -m mypy --strict actors/ap-026-software-release-advisory-ledger/src
python -m ruff format --check actors/ap-026-software-release-advisory-ledger
python -m ruff check actors/ap-026-software-release-advisory-ledger
python -m bandit -q -r actors/ap-026-software-release-advisory-ledger/src
python actors/ap-026-software-release-advisory-ledger/tests/live_probe.py
```

No upload, paid hosted run, or publication is performed by these commands.

# Actor input Schema

## `inputSchemaVersion` (type: `integer`):

Version of this public input contract.

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

Owner and repository name only; arbitrary URLs are not accepted.

## `baselineStoreId` (type: `string`):

Optional Apify key-value store for changes across runs.

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

Include GitHub releases marked as prereleases.

## `includeDrafts` (type: `boolean`):

GitHub only returns drafts visible to the caller. Public unauthenticated checks normally have none.

## `releaseLimit` (type: `integer`):

Maximum number of newest releases to reconcile per repository.

## `advisoryLimit` (type: `integer`):

Maximum number of newest security advisories to reconcile per repository.

## `concurrency` (type: `integer`):

Maximum number of repository checks processed concurrently.

## Actor input object example

```json
{
  "inputSchemaVersion": 1,
  "repositories": [
    {
      "owner": "psf",
      "name": "requests"
    }
  ],
  "includePrereleases": true,
  "includeDrafts": false,
  "releaseLimit": 100,
  "advisoryLimit": 100,
  "concurrency": 5
}
```

# Actor output Schema

## `defaultDataset` (type: `string`):

No description

## `artifactManifest` (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 = {
    "repositories": [
        {
            "owner": "psf",
            "name": "requests"
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("flintglade/software-release-advisory-ledger").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": [{
            "owner": "psf",
            "name": "requests",
        }] }

# Run the Actor and wait for it to finish
run = client.actor("flintglade/software-release-advisory-ledger").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).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": [
    {
      "owner": "psf",
      "name": "requests"
    }
  ]
}' |
apify call flintglade/software-release-advisory-ledger --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=flintglade/software-release-advisory-ledger",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/TTRcDx0umeegGeK8z/builds/hr3rUxTMEXQpqfSCM/openapi.json