| name | check_before_release |
| description | Run before every release to ensure all merged memgraph PRs have a docs label assigned, have changelog entries, have docs pages where required, that all changed text is free of spelling and grammar issues, and that existing documentation cross-links the new content. Use when preparing a release branch, before merging into the main branch, or when asked to "check before release". Also use standalone when asked to audit docs labels on a milestone. |
Check before release
Run this check before every release to audit docs labels on every merged PR, find PRs that are missing from the changelog or that have no documentation page despite being labeled "Docs needed", and to catch spelling/grammar issues in changed documentation.
When to use
- Before merging the main release documentation PR (e.g.
memgraph/documentation#1530 for 3.9)
- When preparing or validating a release branch
- When asked to verify release readiness for docs/changelog
Assumptions
- PR list order: Whenever you present a list of PRs to the user (gaps, backlog,
docs tracking, changelog queue, audit findings, canvas tables, etc.), sort by PR
number ascending (smallest → largest). Apply the same order when listing
documentation PRs linked to memgraph PRs, unless the user asks for a different sort.
- Memgraph PRs that need docs are labeled "Docs needed" or "Docs - changelog only".
- Only consider merged PRs (i.e.
merged_at != null). PRs that are closed without merging must be ignored entirely — no changelog entry, no doc page, not in the tracking list.
- The release documentation PR (in
memgraph/documentation) uses the following Docs Integration Tracking format (three plain checklist sections — no tables):
#### Breaking changes PRs
- [ ] https://github.com/memgraph/memgraph/pull/NNNN — short title @author
#### Docs needed (Memgraph PR → Docs PR)
- [ ] https://github.com/memgraph/memgraph/pull/NNNN → https://github.com/memgraph/documentation/pull/MMMM @author
- [ ] https://github.com/memgraph/memgraph/pull/NNNN → no doc PR yet @author
#### Changelog (all PRs requiring a changelog entry)
- [ ] https://github.com/memgraph/memgraph/pull/NNNN @author