Skip to content
This repository has been archived by the owner on Jan 23, 2025. It is now read-only.

feat: luarocks/rocks.nvim support #71

Merged
merged 1 commit into from
Apr 19, 2024

Conversation

mrcjkb
Copy link
Contributor

@mrcjkb mrcjkb commented Apr 18, 2024

Hey 👋

Summary

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

See also:

With luarocks/rocks.nvim, it is the plugin authors' responsibility to declare dependencies - not the user's.
Installing this plugin, including its dependencies, becomes as simple as :Rocks install feline.nvim.

Things done:

  • Add a workflow that generates a rockspec for Neovim plugins and publishes tags to luarocks.org when a tag or release is pushed.
  • I've added nvim-web-devicons and gitsigns.nvim as dependencies.
    If they aren't installed explicitly by the user (e.g. with :Rocks install gitsigns.nvim), rocks.nvim won't add them to the runtimepath (so they won't impact startup time), but their lua API will be available on the package.path for this plugin to use.

gitsigns.nvim has the same workflow, but hasn't been published to luarocks yet (lewis6991/gitsigns.nvim#964 (comment)).
So I would wait with merging this PR until that has been done.

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.

  • As you use GitHub releases to create tags (with the release-please action), you may need to add a PA token for the workflow to be triggered automatically.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants