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 .