aboutsummaryrefslogtreecommitdiff
path: root/MAINTAIN.md
diff options
context:
space:
mode:
Diffstat (limited to 'MAINTAIN.md')
-rw-r--r--MAINTAIN.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/MAINTAIN.md b/MAINTAIN.md
index 7df91b7d57..9a8531fbd9 100644
--- a/MAINTAIN.md
+++ b/MAINTAIN.md
@@ -52,21 +52,18 @@ has a major bug:
3. Cut a release from `release-x.y`.
- Run `./scripts/release.sh`
- Update (force-push) the remote `stable` tag.
- - The [nightly job](https://github.com/neovim/bot-ci/blob/master/ci/nightly.sh)
+ - The [CI job](https://github.com/neovim/neovim/blob/3d45706478cd030c3ee05b4f336164bb96138095/.github/workflows/release.yml#L11-L13)
will update the release assets based on the `stable` tag.
The neovim repository includes a backport [github action](https://github.com/zeebe-io/backport-action).
In order to trigger the action, a PR must be labeled with a label matching the
-form `backport release-0.X`. If the label is applied before the PR is merged,
-the backport will be filed automatically against the target branch. Otherwise,
-comment `\backport` on the merged PR *after* the label has been applied to trigger
-a backport. Note, the PR must have a description in the issue body, or the backport
-will fail.
+form `backport release-0.X`. Note, the PR must have a description in the issue body,
+or the backport will fail.
Third-party dependencies
--------------
-These "bundled" dependencies can be updated by bumping their versions in `third-party/CMakeLists.txt`:
+These "bundled" dependencies can be updated by bumping their versions in `cmake.deps/CMakeLists.txt`:
- [Lua](https://www.lua.org/download.html)
- [LuaJIT](https://github.com/LuaJIT/LuaJIT)
- [Luv](https://github.com/luvit/luv)
@@ -76,11 +73,18 @@ These "bundled" dependencies can be updated by bumping their versions in `third-
- [lua-compat](https://github.com/keplerproject/lua-compat-5.3)
- [tree-sitter](https://github.com/tree-sitter/tree-sitter)
+`scripts/bump-dep.sh` is a script that can automate this process for `LuaJIT`, `Luv`, `libuv` & `tree-sitter`. See usage guide:
+ - Run `./scripts/bump-deps.sh --dep Luv --version 1.43.0-0` to update a dependency.
+ See `./scripts/bump-deps.sh -h` for more detailed usage
+ - Run `./scripts/bump-deps.sh --pr` to create a pr
+ To generate the default PR title and body, the script uses the most recent commit (not in `master`) with prefix `build(deps): `
+
These dependencies are "vendored" (inlined), we need to update the sources manually:
- [libmpack](https://github.com/libmpack/libmpack)
- [xdiff](https://github.com/git/git/tree/master/xdiff)
- [lua-cjson](https://github.com/openresty/lua-cjson)
- [Klib](https://github.com/attractivechaos/klib)
+ - [inspect.lua](https://github.com/kikito/inspect.lua)
We also maintain some forks, particularly for Windows, if we are waiting on upstream changes:
https://github.com/neovim/neovim/wiki/Deps