From e8da97fca79aee863ed5e2f1ab5e7bb7e36337f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20Taymans?= Date: Sun, 4 May 2025 16:05:56 +0200 Subject: [PATCH] [IMP] release documentation --- DEVELOP.md | 8 ++++++++ newsfragments/+improve-release-documentation.doc | 1 + 2 files changed, 9 insertions(+) create mode 100644 newsfragments/+improve-release-documentation.doc diff --git a/DEVELOP.md b/DEVELOP.md index 866e315..15c5a8a 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -152,6 +152,14 @@ release, if it is a major, minor or patch release. For alpha, beta, etc release information will be published with the next major, minor or patch release. +To generate the `CHANGES.rst`, run the towncrier tool: + +```sh +towncrier build +``` + +Use `--draft` option to preview the result. + Then push a commit with the version and the changlog updated on the main branch. diff --git a/newsfragments/+improve-release-documentation.doc b/newsfragments/+improve-release-documentation.doc new file mode 100644 index 0000000..9108581 --- /dev/null +++ b/newsfragments/+improve-release-documentation.doc @@ -0,0 +1 @@ +Improve release documentation for developpers.