Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
ba03ace
Use the release PR's current section names in the changelog skill
katarinasupe Oct 7, 2026
a399cb1
Point the release grammar check at the writing skill's naming rules
katarinasupe Oct 7, 2026
ceece14
Link each release note to the docs page for its change
katarinasupe Oct 7, 2026
4dfdaf7
Create the docs milestone and handle patch releases in new-release-br…
katarinasupe Oct 13, 2026
b9f2bb0
Check the docs milestone and run pnpm check in check-release-milestone
katarinasupe Oct 13, 2026
cd9c360
Fold the bug-fix wording rule into write-changelog-item
katarinasupe Oct 13, 2026
d9c295f
Check the release PR and close the docs milestone in pre-release
katarinasupe Oct 13, 2026
b1c3f6d
List the release skills in AGENTS.md
katarinasupe Oct 13, 2026
a4ea399
Stop updating the release PR description from write-changelog-item
katarinasupe Oct 13, 2026
b2052e1
Drop the tracking checklist from the release PR in new-release-branch
katarinasupe Oct 13, 2026
aad55a3
Merge check-release-milestone and pre-release into check-release
katarinasupe Oct 13, 2026
a0dccf2
Keep the release overview in the release PR, rebuilt by check-release
katarinasupe Oct 13, 2026
b3c8695
Write release notes from the docs PR's release note corrections
katarinasupe Oct 13, 2026
666d291
Show how much of the Memgraph milestone is merged in check-release
katarinasupe Oct 13, 2026
8e888b1
Fix the problems docs PRs noticed in one PR per release
katarinasupe Oct 13, 2026
a1bfee0
Merge main into update/changelog-skill-sections
katarinasupe Oct 21, 2026
163ea6a
Flag docs for product PRs outside the milestone and gate the release …
katarinasupe Oct 21, 2026
ef5fb1b
Cover patch releases during an open minor release, describe the behav…
katarinasupe Oct 21, 2026
1f5a340
Create the docs GitHub release after the release PR is merged in chec…
katarinasupe Oct 21, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,15 @@

- [ ] For a product change: milestone set to the release and `feature` or `bugfix` label added
- [ ] For a product change: this PR is linked from the product PR's documentation checklist

### Release note corrections

_Read by the release check when the release notes are written. Fix an item if it's wrong; keep the heading and one line per product PR. Delete the section if it's empty._

<!-- - memgraph/memgraph#NNNN: what the product PR's release note gets wrong or misses. -->

### Noticed, not fixed

_Read by the release check, which fixes these in one PR per release. Fix an item if it's wrong; keep the heading and one line per item, starting with the page. Delete the section if it's empty._

<!-- - `pages/<path>.mdx`: what's broken outside this PR's change, and where on the page. -->
9 changes: 8 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,16 @@ The short version, for everyone:
## Branches and PRs

- Docs for a product change go to the docs release branch for that release
(`release/<version>`); other changes go to `main`.
(`release/<version>`, in the docs milestone `<version>`); other changes go
to `main`.
- Releases follow the skills in `skills/`: `new-release-branch` creates the
release branch, docs milestone and release PR; `write-changelog-item`
writes each release note; `check-release` finds what the release still
needs and, on release day, finishes it.
- Use `.github/pull_request_template.md` and name the product PR as
`memgraph/memgraph#NNNN`.
- Keep the headings and line format of "Release note corrections" and
"Noticed, not fixed" in a docs PR description: `check-release` reads them.

## Run locally

Expand Down
9 changes: 8 additions & 1 deletion scripts/check-docs.mjs
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
/**
* Checks the docs source for things that break for readers: links to pages or
* sections that don't exist, links through a redirect, broken redirects, pages
* missing from the sidebar, missing images and mismatched release-note versions.
* missing from the sidebar, missing images, mismatched release-note versions and
* repeated release-note sections.
*
* It reads only this checkout (no build, no network) and runs in a few seconds.
* Any problem fails the check. The rules are the ones in AGENTS.md.
Expand Down Expand Up @@ -325,8 +326,14 @@ const NOTES = path.join(PAGES, 'release-notes.mdx')
if (fs.existsSync(NOTES)) {
const lines = text.get(NOTES).split('\n')
const seen = new Map()
const sections = new Map()
let current = null
lines.forEach((line, i) => {
const s = line.match(/^##\s+(.+?)\s*$/)
if (s) {
if (sections.has(s[1])) report(NOTES, i + 1, `"## ${s[1]}" appears twice (also on line ${sections.get(s[1])})`)
else sections.set(s[1], i + 1)
}
const h = line.match(/^#{2,4}\s+(.+?)\s+v(\d+\.\d+\.\d+)\b/)
if (h) {
current = { product: h[1].trim(), version: h[2], line: i + 1 }
Expand Down
13 changes: 0 additions & 13 deletions skills/README.md

This file was deleted.

157 changes: 0 additions & 157 deletions skills/check-release-milestone/SKILL.md

This file was deleted.

Loading
Loading