Skip to content

Run the Cypher examples and check names on changed pages - #1817

Merged
katarinasupe merged 3 commits into
mainfrom
add/examples-check
Oct 7, 2026
Merged

katarinasupe merged 3 commits into
mainfrom
add/examples-check

Conversation

@katarinasupe

Copy link
Copy Markdown
Contributor

Adds scripts/check-examples.py and an "Examples and names" job. On PRs into main, it runs each changed page's cypher blocks on the latest Memgraph MAGE release (from the release notes) and checks procedure, function and flag names.

  • Fails on problems in the blocks the PR changes; problems elsewhere on the page are warnings.
  • PRs into release branches skip it: their examples are checked when the release branch is merged into main, once that version is out.
  • Uses an Enterprise licence from repo secrets if set; the values are never printed.

Examples that are wrong on purpose are now marked in their fence (neo4j, invalid), as AGENTS.md describes.

scripts/check-examples.py runs each changed page's cypher blocks on the latest Memgraph MAGE release and checks procedure, function and flag names. It fails on problems in the blocks a PR changes and warns about the rest of the page. Runs on PRs into main; release-branch docs are checked when the release branch is merged into main. Examples that are wrong on purpose are marked in their fence (neo4j, invalid).
@katarinasupe katarinasupe self-assigned this Oct 7, 2026
@vercel

vercel Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
documentation Ready Ready Preview Oct 7, 2026 12:42pm UTC

Request Review

@katarinasupe
katarinasupe marked this pull request as ready for review October 7, 2026 12:38
@katarinasupe
katarinasupe merged commit 618c8b7 into main Oct 7, 2026
4 checks passed
@katarinasupe
katarinasupe deleted the add/examples-check branch October 7, 2026 12:43

This branch was successfully deployed

1 active deployment
Preview — a4450978 Deployed Oct 7, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant