vimr/DEVELOP.md

How to develop

To build Neovim for development, i.e., no universal binary, do the following

clean=false for_dev=true ./bin/build_nvimserver.sh

You can set clean=true if you want to clean the existing build.

Generating sources when upgrading Neovim

clean=true ./RxPack/bin/generate_sources.sh # generate API methods
clean=false for_dev=true ./bin/build_nvimserver.sh # generate auto commands and cursor modes

How to enable the Debug menu in Release build

defaults write com.qvacua.VimR enable-debug-menu 1

How to release

Neovim

• Commit and push the new release of Neovim.
• Tag and push with the following

  version=neovim-vX.Y.Z-$(date "+%Y%m%d.%H%M%S"); git tag -a "${version}" -m "${version}"; git push origin "${version}"
  

VimR

• Set a new version of VimR via

  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
  

  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.
• Tag with the name
  • Snapshot: snapshot/yyyymmdd.HHMMSS
  • Release: vX.Y.Z-yyyymmdd.HHMMSS
• Push
• Add release notes to release-notes.temp.md.
• Build, package and upload via

  create_gh_release=true upload=true update_appcast=true \
  release_spec_file=....sh \
  ./bin/build_release.sh
  

• The appcast{-snapshot}.xml file is modified. Check and push.