feat: support luarocks/rocks.nvim

[mrcjkb]

Hey 👋

Summary

This PR is part of a push to get neovim plugins on luarocks.org.

See also:

• rocks.nvim, a new luarocks-based plugin manager.
• this blog post.

With luarocks/rocks.nvim, it is the plugin authors' responsibility to declare dependencies (including tree-sitter parsers) and build instructions - not the user's.
Installing this plugin becomes as simple as :Rocks install neotest-go.nvim.

Things done:

• Add a workflow that publishes tags to luarocks.org when a tag or release is pushed.

See also: this guide

Notes:

Important

• For the luarocks workflow to work, someone with a luarocks.org account will have to add their API key to this repo's GitHub actions secrets.

• Tagged releases are installed locally and then published to luarocks.org.
  • If you push tags from a local checkout, the workflow is triggered automatically.
  • As you are using release-please to create tags, you may need to add a PA token for the workflow to be triggered automatically.
• Due to a shortcoming in luarocks.org (label doesn't get picked up from rockspec luarocks/luarocks-site#188), the neovim and/or vim labels have to be added to the luarocks package manually (after the first upload), for this plugin to show up in https://luarocks.org/labels/neovim or https://luarocks.org/labels/vim, respectively.

[fredrikaverpil]

Thanks @mrcjkb !

I'll read up on this subject and add the API key when I'm back from 🏖️🌴.

[fredrikaverpil]

Hm... does this imply that this dependency should also be part of the current lazy.nvim instructions in the README?

I didn't quite understand if this was part of the upcoming changes to Neovim.

[mrcjkb]

No, luarocks tree-sitter parsers currently only work with rocks.nvim.
lazy.nvim users will probably still want to use nvim-treesitter to install parsers.

[fredrikaverpil]

Ok, thanks!

One more question. Lazy.nvim recently started supporting rockspecs: https://lazy.folke.io/packages#rockspec
Isn't that what gets uploaded to luarocks?

Would it make sense for me to create one and then direct this GitHub action to read it?

[mrcjkb]

lazy.nvim can install from luarocks if there's a rockspec in the repo root, but it doesn't treat luarocks packages as first class citizens, so it won't be able to use the tree-sitter-go dependency.

The Github action doesn't yet support using scm rockspecs as a template. See:

• [QOL] Ability to use scm rockspec in root directory as a rockspec template nvim-neorocks/luarocks-tag-release#435

[fredrikaverpil]

Ok, thanks for these insights! 💡

[fredrikaverpil]

I've now added the secrets.LUAROCKS_API_KEY as well as a PAT for release please (in #157). Let's try it?