Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update extension extraction docs (#24079)

Browse source 
- Fixed a regex for finding tags.
- Templatize the instructions with `$LANGNAME` to prevent manual errors
from failing to edit commands (this bit me)
- Ran formatting through Prettier
This commit is contained in:
Peter Tripp 2025-02-06 19:01:32 -05:00 • committed by GitHub
parent 337b9e62d2
commit 5315d38cf4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 84 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

90
extensions/EXTRACTION.md
View file

@ -1,6 +1,6 @@
# Extracting an extension to dedicated repo
These are some notes of how to extract an extension from the main zed repository and generate a new repository which preserves the history as best as possible. In the this example we will be extracting the `ruby` extension, substitute as appropriate.
These are some notes of how to extract an extension from the main zed repository and generate a new repository which preserves the history as best as possible. In the this example we will be extracting the `ruby` extension, substitute as appropriate.
## Pre-requisites
@ -23,7 +23,7 @@ regex:(?<![\[a-zA-Z0-9])(#[0-9]{3,5})==>zed-industries/zed\1
```
This file takes the form of `patern==>replacement`, where the replacement is optional.
Note whitespace matters so `ruby: ==>` is removing the `ruby:` prefix from a commit messages and adding a space after `==> ` means the replacement begins with a space. Regex capture groups are numbered `\1`, `\2`, etc.
Note whitespace matters so `ruby: ==>` is removing the `ruby:` prefix from a commit messages and adding a space after `==> ` means the replacement begins with a space. Regex capture groups are numbered `\1`, `\2`, etc.
See: [Git Filter Repo Docs](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html) for more.
@ -34,16 +34,17 @@ See: [Git Filter Repo Docs](https://htmlpreview.github.io/?https://github.com/ne
> `setopt interactive_comments && echo "setopt interactive_comments" >> ~/.zshrc`
```sh
rm -rf zed3
git clone --single-branch --no-tags git@github.com:zed-industries/zed.git zed3
cd zed3
LANGNAME=ruby
rm -rf $LANGNAME
git clone --single-branch --no-tags git@github.com:zed-industries/zed.git $LANGNAME
cd $LANGNAME
# This removes the LICENSE symlink
git filter-repo --invert-paths --path extensions/ruby/LICENSE-APACHE
git filter-repo --invert-paths --path extensions/$LANGNAME/LICENSE-APACHE
git filter-repo \
--use-mailmap \
--subdirectory-filter extensions/ruby/ \
--subdirectory-filter extensions/$LANGNAME/ \
--path LICENSE-APACHE \
--replace-message ~/projects/expressions.txt
```
@ -65,10 +66,11 @@ You can always add tags later, but it's a nice touch.
Show you all commits that mention a version number:
```sh
git log --grep="(\d+\.\d+\.\d+\.)" --perl-regexp --oneline --reverse
git log --grep="(\d+\.\d+\.\d+)" --perl-regexp --oneline --reverse
```
Then just:
```
git tag v0.0.2 abcd1234
git tag v0.0.3 deadbeef
@ -76,13 +78,77 @@ git tag v0.0.3 deadbeef
Usually the initial extraction didn't mention a version number so you can just do that one manually.
4. Push to the new repo
4. [Optional] Add a README.md and commit.
Create a new empty repo on github under the [zed-extensions](https://github.com/zed-extensions) organization.
5. Push to the new repo
Create a new empty repo on github under the [zed-extensions](https://github.com/organizations/zed-extensions/repositories/new) organization.
```
git remote add origin git@github.com:zed-extensions/ruby
git remote add origin git@github.com:zed-extensions/$LANGNAME
git push origin main --tags
git branch --set-upstream-to=origin/main main
```
5. [Optional]
6. Setup the new repository:
- Go to the repository settings:
- Disable Wikis
- Uncheck "Allow Merge Commits"
- Check "Allow Squash Merging"
- Default commit message: "Pull request title and description"
7. Publish a new version of the extension.
```
OLD_VERSION=$(grep '^version = ' extension.toml | cut -d'"' -f2)
NEW_VERSION=$(echo "$OLD_VERSION" | awk -F. '{$NF = $NF + 1;} 1' OFS=.)
echo $OLD_VERSION $NEW_VERSION
perl -i -pe "s/$OLD_VERSION/$NEW_VERSION/" extension.toml
# if there's rust code, update this too.
test -f Cargo.toml && perl -i -pe "s/$OLD_VERSION/$NEW_VERSION/" cargo.toml
test -f Cargo.toml && cargo check
# commit and push
git add -u
git checkout -b "bump_${NEW_VERSION}"
git commit -m "Bump to v${NEW_VERSION}"
git push
gh pr create --title "Bump to v${NEW_VERSION}" --web
# merge PR in web interface
git checkout main
git pull
git tag v${NEW_VERSION}
git push origin v${NEW_VERSION}
```
7. In zed repository, `rm -rf extension/langname` and push a PR.
8. Update extensions repository:
```sh
cd ../extensions
git checkout main
git pull
git submodule init
git submodule update
git status
git checkout -b ${LANGNAME}_v${NEW_VERSION}
git submodule add https://github.com/zed-extensions/${LANGNAME}.git extensions/${LANGNAME}
pnpm sort-extensions
# edit extensions.toml:
# - bump version
# - change `submodule` from `extensions/zed` to new path
# - remove `path` line all together
git add extensions.toml .gitmodules extensions/${LANGNAME}
git diff --cached
git commit -m "Bump ${LANGNAME} to v${NEW_VERSION}"
git push
```
Create PR and reference the Zed PR with removal from tree.