1
1
mirror of https://github.com/qvacua/vimr.git synced 2024-12-13 01:43:20 +03:00
vimr/DEVELOP.md

49 lines
1.4 KiB
Markdown
Raw Normal View History

2021-12-13 20:47:02 +03:00
## How to develop
2022-06-30 22:27:20 +03:00
To build NvimServer, do the following
2021-12-13 20:47:02 +03:00
```bash
2022-06-30 22:27:20 +03:00
build_libnvim=true clean=false ./bin/build_nvimserver_for_local_dev.sh
2021-12-13 20:47:02 +03:00
```
2022-06-30 22:27:20 +03:00
You can set `clean=true` if you want to clean the existing build.
2021-12-13 20:47:02 +03:00
You can also use a watch script as follows (it uses `entr`):
```bash
clean_initial_build=true ./bin/watch_nvimserver_and_build
```
2022-02-13 11:46:54 +03:00
When `clean_initial_build` is `true`, the script will clean and build,
2021-12-13 20:47:02 +03:00
then continuously invoke the `build_nvimserver_for_local_dev` script.
2022-06-30 22:28:45 +03:00
## How to build nightly
```bash
git tag -f neovim-nightly; git push -f origin neovim-nightly
```
Then, GitHub actions will build and re-create the release.
2021-12-13 20:47:02 +03:00
## How to release
* Set a new version of VimR via
```bash
2022-03-24 20:08:11 +03:00
is_snapshot=true ./bin/set_new_versions.sh # for snapshot or
is_snapshot=false marketing_version=0.38.3 ./bin/set_new_versions.sh # for release
2021-12-13 20:47:02 +03:00
```
2022-03-24 20:08:11 +03:00
and commit. This will create a `${bundle_version}-snapshot/release.sh` file to be used
with `build_release.sh` and `release-notes.temp.md` for release notes.
2021-12-13 20:47:02 +03:00
* Tag with the name
- Snapshot: `snapshot/yyyymmdd.HHMMSS`
2022-03-12 22:25:52 +03:00
- Release: `vX.Y.Z-yyyymmdd.HHMMSS`
2022-03-24 20:08:11 +03:00
* Push
* Add release notes to `release-notes.temp.md`.
2021-12-13 20:47:02 +03:00
* Build, package and upload via
```bash
2022-03-24 20:08:11 +03:00
create_gh_release=true upload=true update_appcast=true \
release_spec_file=....sh \
2021-12-13 20:47:02 +03:00
./bin/build_release.sh
```
* The `appcast{-snapshot}.xml` file is modified. Check and push.
2022-03-24 20:08:11 +03:00