From ad3886e14243e65f59543a250a955bcbb36ac072 Mon Sep 17 00:00:00 2001 From: Vector73 Date: Sat, 1 Mar 2025 18:25:11 +0000 Subject: [PATCH] docs: Document new `create-api-changelog` tool. --- docs/documentation/api.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/documentation/api.md b/docs/documentation/api.md index 5fed08a67a..608d82d59f 100644 --- a/docs/documentation/api.md +++ b/docs/documentation/api.md @@ -333,11 +333,15 @@ above. make sure that copy-pasting the code in your examples works, and post an example of the output in the pull request. -1. Document the new API in `api_docs/changelog.md` and - bump the `API_FEATURE_LEVEL` in `version.py`. Also, make sure to - add a `**Changes**` entry in the description of the new API/event - in `zerver/openapi/zulip.yaml`, which mentions the API feature level - at which they were added. +1. Run `./tools/create-api-changelog` which will create a new empty + changelog file in `api_docs/unmerged.d/` directory. Open this + file and document the API changes. The content of this file will be + merged into `api_docs/changelog.md` when your commit is merged into the + `main` branch. + +1. Add a `**Changes**` entry in the description of the new API/event in + `zerver/openapi/zulip.yaml`, and mention the name of the file generated + in the previous step in place of the API feature level. ## Why a custom system?