// Create/write the changelog item / release note for a given Github PR and update the docs release PR 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.
Create a new release branch for Memgraph documentation with the initial release-notes scaffold commit and PR. Use when the user wants to start a new release, create a release branch, or prepare release notes for a new version.
Run final pre-release tasks for the documentation site. Updates release note dates, direct download links to the new Memgraph version, and rebuilds the site to regenerate the sitemap. Use when preparing a documentation release, before publishing, or when asked to run "pre-release" steps.
| name | write_changelog_item |
| description | Create/write the changelog item / release note for a given Github PR and update the docs release PR description. |
For a given Github PR write a changelog item.
The changelog item should be benefit focused (highlight the why). The changelog item should be in the markdown format, don't remove ticks and markdown links, don't use bold and italic, use - at the beginning of the item.
Usually the PR has the item written in one of the comments under the PR. Try to extract that first and improve according to the above description.
If that changelog item is not already there, feel free to create one, again according to the above guidelines.
If the PR introduces a breaking change, write 2 items: one for the "regular" sections (Features, Improvements, Bug Fixes) and one for the Breaking section. The item under the Breaking section should be in the format: "What happened? What the end-user should do about it?".
After writing the changelog item in pages/release-notes.mdx, also update the
description of the open documentation release PR (e.g.
memgraph/documentation#1530 for 3.9) so the PR keeps a complete overview of
everything integrated in the release.
gh api.- [x] https://github.com/memgraph/memgraph/pull/XXXX @author
Append the new entry at the end of the list (before the blank line / TODO).- [x] https://github.com/memgraph/memgraph/pull/XXXX -> https://github.com/memgraph/documentation/pull/YYYY @authorgh api ... -X PATCH -F "body=@file".