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 and build instructions - not the user's.
Installing this plugin becomes as simple as :Rocks install markdown.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.
  • If you use GitHub releases 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.

[mrcjkb]

Note: The tree-sitter-markdown luarocks package has tree-sitter-markdown_inline as a dependency, so there's no need to specify it here.

[MeanderingProgrammer]

Thanks for the PR! I'm not very familiar with luarocks, but I get the general concept of moving more plugins into the repository.

I'll take a closer look at this and come back to it in a few days after I get some familiarity.

Thanks for putting this together!

[MeanderingProgrammer]

Thanks again for putting this together, I had a couple of clarifying questions just so I understand what's going on.

[MeanderingProgrammer]

Neat action :)

If we use @v7 do the labels get picked up, or is this a more general problem?

https://github.com/nvim-neorocks/luarocks-tag-release?tab=readme-ov-file#labels

[mrcjkb]

Oops, my bad. This should be using v7.
v5 tries to run busted tests if a .busted file is present. We moved that to a separate action, because it caused issues with this one.

The labels problem is a luarocks-site bug.

[MeanderingProgrammer]

I assume both of these are needed for the tree-sitter-* dependencies but I can't quite figure out why.

Like why does the environment that publishes the package need to have tree-sitter-cli available?

Do the dependencies need to be built as part of the upload?

[mrcjkb]

luarocks-tag-release tries to install the package from the generated rockspec, before trying to upload (which also installs and builds dependencies).
If installing fails, it cancels the upload.

[MeanderingProgrammer]

Ah, okay, that makes sense, to make sure what you upload actually works. I also now get what the Tests packaging on PR comment means. Thanks!

[MeanderingProgrammer]

Change looks good, I've added the api secret to the repo, should be good to go.

[MeanderingProgrammer]

Looks like its there: https://luarocks.org/modules/MeanderingProgrammer/markdown.nvim

Added the neovim label.

[mrcjkb]

Thanks 🙏
Don't hesitate to ping me if you have any issues later on.

Edit:

Just tried it out with rocks.nvim:

:Rocks install markdown.nvim
:e README.md

works like a charm!