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: luarocks/rocks.nvim support #578

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

Conversation

mrcjkb
Copy link

@mrcjkb mrcjkb commented Apr 16, 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 becomes as simple as :Rocks install harpoon.

Things done:

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

The workflows are based on this guide

Notes:

Important

  • On each merge to master (if this lands on master), 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, a changelog update, and a GitHub release, which will trigger the luarocks workflow.
    If you would like versioning to start from a specific version (e.g. 2.0.0), you can configure this with a manifest.
  • 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.

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.

1 participant