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 #22

Merged
merged 1 commit into from
Apr 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
feat: luarocks/rocks.nvim support
mrcjkb committed Apr 13, 2024
commit 35b1dd3adaee733b2023ad54ca0798dd5e0163c8
32 changes: 32 additions & 0 deletions .github/workflows/luarocks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Push to Luarocks

on:
push:
tags:
- '*'
release:
types:
- created
tags:
- '*'
workflow_dispatch:
pull_request: # Tests the luarocks packaging and installation without publishing

jobs:
luarocks-upload:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0 # Required to count the commits
- name: Get Version
run: echo "LUAROCKS_VERSION=$(git describe --abbrev=0 --tags)" >> $GITHUB_ENV
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v5
env:
LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
with:
version: ${{ env.LUAROCKS_VERSION }}
dependencies: |
nui.nvim
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -38,6 +38,14 @@ use {
}
```

## For plugin developers

Consider [publishing your plugin to luarocks](https://github.com/nvim-neorocks/sample-luarocks-plugin),
so that your users don't have to declare dependencies themselves
when installing with a luarocks-compatible plugin manager
like [rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim)
or lazy.nvim extended with [luarocks.nvim](https://github.com/vhyrro/luarocks.nvim).

## Discord

Join [Discord](https://discord.gg/Rj2V3keVS4) to get involved with the community, ask questions, and share tips.