Skip to content

Commit 35b1dd3

Browse files
committed
feat: luarocks/rocks.nvim support
1 parent 0af84e5 commit 35b1dd3

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

.github/workflows/luarocks.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Push to Luarocks
3+
4+
on:
5+
push:
6+
tags:
7+
- '*'
8+
release:
9+
types:
10+
- created
11+
tags:
12+
- '*'
13+
workflow_dispatch:
14+
pull_request: # Tests the luarocks packaging and installation without publishing
15+
16+
jobs:
17+
luarocks-upload:
18+
runs-on: ubuntu-22.04
19+
steps:
20+
- uses: actions/checkout@v3
21+
with:
22+
fetch-depth: 0 # Required to count the commits
23+
- name: Get Version
24+
run: echo "LUAROCKS_VERSION=$(git describe --abbrev=0 --tags)" >> $GITHUB_ENV
25+
- name: LuaRocks Upload
26+
uses: nvim-neorocks/luarocks-tag-release@v5
27+
env:
28+
LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
29+
with:
30+
version: ${{ env.LUAROCKS_VERSION }}
31+
dependencies: |
32+
nui.nvim

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ use {
3838
}
3939
```
4040

41+
## For plugin developers
42+
43+
Consider [publishing your plugin to luarocks](https://github.com/nvim-neorocks/sample-luarocks-plugin),
44+
so that your users don't have to declare dependencies themselves
45+
when installing with a luarocks-compatible plugin manager
46+
like [rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim)
47+
or lazy.nvim extended with [luarocks.nvim](https://github.com/vhyrro/luarocks.nvim).
48+
4149
## Discord
4250

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

0 commit comments

Comments
 (0)