Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: rocks.nvim/luarocks support #320

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mrcjkb
Copy link

@mrcjkb mrcjkb commented Mar 12, 2023

Summary

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

Things done:

  • Add a release-please workflow that creates release PRs with SemVer versioning based on conventional commits.
  • Add a workflow that publishes tags to LuaRocks when a tag or release is pushed.

The workflows are based on this guide by @vhyrro.

Notes:

Important

  • On each merge to main, the release-please workflow creates (or updates an existing) release PR.
  • You decide when to merge release PRs.
    Doing so will result in a SemVer tag, and a GitHub release, which will trigger the luarocks workflow.
  • Tagged releases are installed locally and then published to luarocks.org.
    On PRs, a test release is installed, but not published.
  • 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.

Adding the API key (screen shot)
github-add-luarocks-api-key

@harrisoncramer
Copy link
Contributor

Are there any plans to add this, aka Luarocks support?

We have an upstream plugin that uses diffview.nvim (it's fantastic by the way) and we'd like to be able to install it via LuaRocks to run tests in our CI/CD pipeline, if possible!

@mrcjkb mrcjkb changed the title feat: luarocks support feat: rocks.nvim/luarocks support Apr 4, 2024
@mrcjkb
Copy link
Author

mrcjkb commented Apr 4, 2024

As there has been no response, I will add this plugin to the NURR, which means diffview.nvim will be published to luarocks.org under the neorocks organisation account.

@sindrets if you would like to merge this one day, please ping me, and I will remove the package from the luarocks root manifest.

@harrisoncramer because diffview.nvim doesn't have tagged releases, the NURR workflow will only publish an scm rockspec.
You could add it as a dependency to gitlab.nvim, but luarocks won't be able to resolve the dependency unless installing gitlab.nvim with a dev version (or using the --dev flag).
For this reason, I would suggest not publishing a non-scm rockspec to luarocks until all of gitlab.nvim's dependencies have semver releases on luarocks.org.

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

Successfully merging this pull request may close these issues.

None yet

2 participants