From 660234fed25802f49fe512407e655635f357cf9d Mon Sep 17 00:00:00 2001 From: Finn Evers Date: Tue, 9 Dec 2025 12:49:33 +0100 Subject: [PATCH] docs: Improve documentation for updating an extension (#44475) Release Notes: - N/A --- docs/src/extensions/developing-extensions.md | 22 ++++++++------------ 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/docs/src/extensions/developing-extensions.md b/docs/src/extensions/developing-extensions.md index 539cbe3d3044afe30b6ced4f3ceb61f537ebde75..dc8a69329176c8dbb7f9785913ae4b7aac6fb230 100644 --- a/docs/src/extensions/developing-extensions.md +++ b/docs/src/extensions/developing-extensions.md @@ -109,18 +109,6 @@ git submodule init git submodule update ``` -## Update Your Extension - -When developing/updating your extension, you will likely need to update its content from its submodule in the extensions repository. -To quickly fetch the latest code for only specific extension (and avoid updating all others), use the specific path: - -```sh -# From the root of the repository: -git submodule update --remote extensions/your-extension-name -``` - -> Note: If you need to update all submodules (e.g., if multiple extensions have changed, or for a full clean build), you can run `git submodule update` without a path, but this will take longer. - ## Extension License Requirements As of October 1st, 2025, extension repositories must include a license. @@ -177,7 +165,15 @@ To update an extension, open a PR to [the `zed-industries/extensions` repo](http In your PR do the following: -1. Update the extension's submodule to the commit of the new version. +1. Update the extension's submodule to the commit of the new version. For this, you can run + +```sh +# From the root of the repository: +git submodule update --remote extensions/your-extension-name +``` + +to update your extension to the latest commit available in your remote repository. + 2. Update the `version` field for the extension in `extensions.toml` - Make sure the `version` matches the one set in `extension.toml` at the particular commit.