# Release Notes Completeness Gate for a Git Tag Range (`kingii98/release-notes-completeness-gate-for-a-git-tag-range`) Actor

Find each merged pull request in a tag range that the release notes do not mention.

- **URL**: https://apify.com/kingii98/release-notes-completeness-gate-for-a-git-tag-range.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

$50.00 / 1,000 range auditeds

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

## Release Notes Completeness Gate for a Git Tag Range

This Actor finds each merged pull request (PR) in a tag range that the release notes do not mention. Use it before you publish a release.

### Input

| Field | Required | Description |
| --- | --- | --- |
| `repository` | Yes | GitHub repository as `owner/name`. Default: `psf/requests`. |
| `baseTag` | Yes | Older tag. Default: `v2.32.0`. |
| `headTag` | Yes | Newer tag. Default: `v2.32.1`. |
| `githubToken` | No | GitHub token. It raises the rate limit. The Actor sends it only to `api.github.com`. |
| `releaseNotes` | No | Release notes text. It has priority over `releaseId`. |
| `releaseId` | No | GitHub release ID. The Actor reads the release body. |

If you give no notes and no release ID, the Actor reads the release for `headTag`. If that release does not exist, all PRs count as missing. The summary row shows `notes_source` as `none`.

A PR counts as mentioned when the notes contain `#<number>` or `/pull/<number>`.

### Output

The dataset has one row for each merged PR:

- `number`, `title`, `labels`
- `category`: `added`, `fixed`, `changed`, or `removed`. The Actor picks it from keywords in the title and labels. The default is `changed`.
- `mentioned_in_notes`: `true` or `false`

The last row is the summary row:

- `verdict`: `pass`, `fail`, or `error`
- `missing_count`, `total_pull_requests`, `notes_source`, `message`

A failed gate, a bad input, or a GitHub error is a dataset row and a status message. The run still ends with SUCCEEDED.

### Limits

- The range can have 250 commits at most. A larger range gives an `error` verdict.
- The Actor calls only `api.github.com`. It does not follow redirects.
- Each response has a 5 MB limit. Each request has a 15 second timeout. The Actor makes 5 requests at the same time at most.
- Without a token, GitHub allows 60 requests each hour. A range needs about one request for each commit. Use a token for large ranges.
- The Actor keeps no state between runs.

### Pricing event

| Event | Unit | Price (USD) |
| --- | --- | --- |
| `range-audited` | One tag range audited | 0.05 |

The Actor calls `Actor.charge` one time for each range that it audits, with a `pass` or `fail` verdict. It does not charge when the verdict is `error`.

### Development

```
uv run pytest
uv run ruff check .
```

# Actor input Schema

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

Repository in the form owner/name.

## `baseTag` (type: `string`):

Older tag. The range starts after this tag.

## `headTag` (type: `string`):

Newer tag. The range ends at this tag.

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

Optional token. It raises the GitHub rate limit. The Actor sends it only to api.github.com.

## `releaseNotes` (type: `string`):

Optional release notes text. It has priority over the release ID.

## `releaseId` (type: `integer`):

Optional GitHub release ID. The Actor reads the body of this release.

## Actor input object example

```json
{
  "repository": "psf/requests",
  "baseTag": "v2.32.0",
  "headTag": "v2.32.1"
}
```

# Actor output Schema

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

Dataset rows for the audited range.

# 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": "psf/requests",
    "baseTag": "v2.32.0",
    "headTag": "v2.32.1"
};

// Run the Actor and wait for it to finish
const run = await client.actor("kingii98/release-notes-completeness-gate-for-a-git-tag-range").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": "psf/requests",
    "baseTag": "v2.32.0",
    "headTag": "v2.32.1",
}

# Run the Actor and wait for it to finish
run = client.actor("kingii98/release-notes-completeness-gate-for-a-git-tag-range").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": "psf/requests",
  "baseTag": "v2.32.0",
  "headTag": "v2.32.1"
}' |
apify call kingii98/release-notes-completeness-gate-for-a-git-tag-range --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,kingii98/release-notes-completeness-gate-for-a-git-tag-range"
        }
    }
}
```

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/fXggIifxDI4SBSiMi/builds/Yud8hdfP8CVoAKLUe/openapi.json