feat: publish releases to luarocks

[mrcjkb]

Hey 👋

Summary

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

See also:

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

Things done:

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

Notes:

• Tagged releases are installed locally and then published to luarocks.org.
• 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.
• Due to a shortcoming in LuaRocks (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.

See also this guide.

[mrcjkb]

@lewis6991 thanks for supporting this 😃
Would you mind running the workflow in the v0.7 tag (if you have the API key set up)? 🙏

[lewis6991]

No problem. I've ran it, but it's failed for some reason.

[mrcjkb]

stdout: 
stderr: Usage: .luarocks-wrapped upload [-h] [--skip-pack] [--api-key <key>]
       [--temp-key <key>] [--force] [--sign] <rockspec> [<src-rock>]

Error: option '--api-key' requires an argument

Looks like there's no API key in the repo's GitHub Actions secrets?

[lewis6991]

Should there be? What is the key required for?

[mrcjkb]

Should there be? What is the key required for?

Yes, an API key is necessary to be able to upload to luarocks.org.

• 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.

[mrcjkb]

Should there be? What is the key required for?

Yes, an API key is necessary to be able to upload to luarocks.org.

• 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.

@lewis6991 any thoughts on this?
Generally, I think it's best if plugins push to luarocks themselves, but if you would not like to open a luarocks.org account, I can also revert this and add gitsigns.nvim to the NURR, in which case it would be published under the neorocks org.

[lewis6991]

@teto did you originally set up gitsigns on Luarocks? If so do you still have the account details?

[teto]

I have. Do you want me to relinquish the luarocks.org name for gitsigns ? (I would gladly do so)

[mrcjkb]

I have. Do you want me to relinquish the luarocks.org name for gitsigns ? (I would gladly do so)

@teto I think the best option is for you to delete the gitsigns scm rock from the root manifest, since it's published under your personal account.

[teto]

@lewis6991 and I convened on matrix that I would relinquish the root manifest when he is ready

[teto]

I've released the name on luarocks.org since the luarocks install would fail anyway nvim-neorocks/rocks.nvim#422 . Now would be a good time to create a new release ^^

[simifalaye]

@lewis6991 Any news on when a release will be made?