From 8a1622025eae6158db049c4cbc097734dbbcbe50 Mon Sep 17 00:00:00 2001 From: Vitovt Date: Tue, 19 May 2026 22:22:49 +0300 Subject: [PATCH] docs: document release notes files --- release-notes/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 release-notes/README.md diff --git a/release-notes/README.md b/release-notes/README.md new file mode 100644 index 0000000..1528608 --- /dev/null +++ b/release-notes/README.md @@ -0,0 +1,10 @@ +# Release Notes + +Create one Markdown file per release tag, named exactly after the version: + +```text +release-notes/1.2.0.md +release-notes/1.2.1.md +``` + +When a version tag is pushed, the release workflow uses the matching file as the GitHub release description. The file must be committed before the tag is pushed.