This represents a checklist to do before each stable release of the plugin.
Within lua/distant/init.lua, we need to ensure two fields are up-to-date:
MIN_VERSIONrepresents the minimum CLI version to support (e.g.0.20.0-alpha.7)PLUGIN_VERSIONrepresents the version of the plugin and should match the tag we use minus thevprefix (e.g.0.3.0)
Re-generate vimdoc from our markdown. Ensure that it is reflected in
doc/distant.txt or other docs as well as https://distant.dev/docs/neovim.
Ensure that our changelog properly reflects the additions since the last version. Additionally, these changes should be reflected at https://distant.dev/changelog/neovim.
Like usual, all automated tests should pass on our CI. We can run these
manually using make test-unit and make test-e2e with the caveat that our
local machine needs to be configured for passwordless ssh in order to run the
end-to-end tests.
Additionally, beyond our automated tests, there are a series of manual tests we should run to make sure the plugin works:
- Try a full suite of
:DistantInstallruns. - Open up the
:Distantwindow