# GitHub Release History Export — Notes by Date Window (`jpmarketdata/github-release-history-export`) Actor

Export published release notes for public GitHub repositories across an inclusive date window. Keep exact IDs, tags and prerelease flags; fail before delivery if the bounded history cannot be completed.

- **URL**: https://apify.com/jpmarketdata/github-release-history-export.md
- **Developed by:** [h ichi](https://apify.com/jpmarketdata) (community)
- **Categories:** Developer tools, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$1.00 / 1,000 release delivereds

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 History Export

Collect published release notes for up to three exact public repositories and an inclusive UTC publication-date window. Review intervening upstream changes or feed source notes into your own ticket/LLM workflow. Notes are untrusted source material, not instructions or compatibility advice.

### Input

`repositories`: 1–3 `owner/name` public GitHub identities, default `["cli/cli"]`. Case-insensitive duplicates collapse; arbitrary URLs, tokens and unknown keys fail before networking. `publishedFrom`/`publishedTo`: valid inclusive UTC YYYY-MM-DD dates, default 2026-09-01..2026-09-30. `includePrereleases`: boolean, default true. `maxSafetyItems`: 1–500, default500; fail rather than truncate when matching rows exceed it. Normal nondefault example: psf/requests, 2025-01-01..2026-10-15. Caller chooses dates; there is no automatic installed-version or commit-range resolution.

### Output

One `github_release` row per unique release: repository, numeric releaseId, tagName, sanitized name, publishedAt, createdAt, source prerelease flag, notesMarkdown, notesPresent, sourceUrl, licenseUrl and retrievedAt. Notes preserve Markdown except contact/secret/mention redaction; empty notes remain empty and notesPresent=false. Sorted by repository then publication time and release ID ascending. Metadata author/profile/uploader objects are excluded. COVERAGE/SUMMARY/RUN-SUMMARY are uncharged key-value records. No matching releases is an explicit no-matching-results failure with coverage, no rows/events. Bare tags, drafts, private repos, assets/binaries, commit diffs and generated release notes are outside scope. Review repository licenses before reusing notes; licenseUrl is a reference and is not itself fetched.

### Limits

Every repository is fully paged in groups of50, up to ten pages (500source releases/repository). Traversal never stops on a date cutoff because source ordering is not assumed. A remaining next page fails refine-required, even if the selected date window is narrow: use a smaller-history repository; narrowing dates only helps the output cap. Recheck first page IDs/publication state after traversal; duplicates or detected drift fail. Concurrent source edits can still prevent a transactionally stable snapshot; coverageComplete describes the observed traversal only. Three repos,34HTTP requests including robots and drift checks; 15sec request timeout,180sec acquisition,90sec delivery,4MiB response wire/decoded,64MiB aggregate transfer/decoded,24MiB staged result,256MB. No retries/redirects, auth/cookies/proxy/browser or paid dependency. Only first-party API routes are fetched; current robots and public DNS pinning apply. 403 quota exhaustion/429, authentication, timeouts, malformed data, identity changes and caps fail visibly before delivery.

### Pricing

Published price: $0.001 per unique release-delivered primary event, with no start or trial charge. Private cloud probes verified 4/4 default, 7/7 alternate and 63/63 maximum-load dataset rows to primary events. Acquire/validate the entire selected result before delivery. PPE allowance must cover every row and is rechecked before each <=50-row SDK push; short charged acknowledgements fail. Non-PPE stores rows with zero charge. Source failure and coverage metadata are uncharged. SDK writes have no whole-run rollback; earlier batches may remain if a later delivery fails. Private cloud runs confirmed primary event counts; platform compute cost remains separate. Repeated runs charge delivered rows again.

### Privacy

Only public repository release content is exported. Exclude author/profile/uploader/contact fields; redact email/phone/common secret patterns and @mentions from notes and names. No credentials, cookies, private access or linked URL retrieval. Redaction is pattern-based and not a guarantee of detecting every possible personal datum. GitHub is the source and does not endorse this Actor.

# Actor input Schema

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

1–3 exact public owner/name identities. URLs/private repositories unsupported; case-insensitive duplicates collapse. Default cli/cli.

## `publishedFrom` (type: `string`):

Inclusive valid YYYY-MM-DD UTC date. Filters source published_at after complete bounded history traversal.

## `publishedTo` (type: `string`):

Inclusive valid YYYY-MM-DD UTC date; cannot precede publishedFrom.

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

Include source prerelease=true records as well as stable releases; never infer semver order.

## `maxSafetyItems` (type: `integer`):

1–500 total releases across all repos. Safety cap, not truncation: larger matching result fails before row delivery. Repository traversal separately limited to 500 source releases each.

## Actor input object example

```json
{
  "repositories": [
    "cli/cli"
  ],
  "publishedFrom": "2026-09-01",
  "publishedTo": "2026-09-30",
  "includePrereleases": true,
  "maxSafetyItems": 500
}
```

# Actor output Schema

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

Export published release notes for public GitHub repositories across an inclusive date window. Keep exact IDs, tags and prerelease flags; fail before delivery if the bounded history cannot be completed.

# 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 = {};

// Run the Actor and wait for it to finish
const run = await client.actor("jpmarketdata/github-release-history-export").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 = {}

# Run the Actor and wait for it to finish
run = client.actor("jpmarketdata/github-release-history-export").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 '{}' |
apify call jpmarketdata/github-release-history-export --silent --output-dataset

```

## MCP server setup

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

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/1Zd0Hp7Ih3WZH5639/builds/XUp4cRoCTKGrL1GEh/openapi.json
