Skip to content

[CI]: support luarocks/rocks.nvim #36

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
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
27 changes: 27 additions & 0 deletions .github/workflows/luarocks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Luarocks

on:
push:
tags:
- 'v*'
release:
types:
- created
pull_request: # Test this on PR without uploading
workflow_dispatch:

jobs:
luarocks-upload:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # Required to get the tags
- 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 }}
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,13 @@
1. Create file `plugin/0-tangerine.lua` to bootstrap tangerine:

> [!IMPORTANT]
> If you are using [lazy.nvim](https://github.com/folke/lazy.nvim) then you should create `init.lua` instead of `plugin/0-tangerine.lua`.
>
> Refer to [#20](https://github.com/udayvir-singh/tangerine.nvim/issues/20) for more information.
> - If you are using [lazy.nvim](https://github.com/folke/lazy.nvim) then you should create `init.lua` instead of `plugin/0-tangerine.lua`.
> Refer to [#20](https://github.com/udayvir-singh/tangerine.nvim/issues/20) for more information.
>
> - If you are using [rocks.nvim](https://github.com/nvim-neorocks/rocks.nvim), there is no need to bootstrap this plugin
> (unless you want to write your rocks.nvim bootstrap script in Fennel).
> Install with `:Rocks install tangerine.nvim` and skip to step 2.

```lua
-- ~/.config/nvim/plugin/0-tangerine.lua or ~/.config/nvim/init.lua
Expand Down
12 changes: 8 additions & 4 deletions doc/tangerine.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,14 @@ ANISEED

1. Create file `plugin/0-tangerine.lua` to bootstrap tangerine:

[!IMPORTANT] If you are using lazy.nvim <https://github.com/folke/lazy.nvim>
then you should create `init.lua` instead of `plugin/0-tangerine.lua`. > Refer
to #20 <https://github.com/udayvir-singh/tangerine.nvim/issues/20> for more
information.
[!IMPORTANT] > - If you are using lazy.nvim
<https://github.com/folke/lazy.nvim> then you should create `init.lua` instead
of `plugin/0-tangerine.lua`. Refer to #20
<https://github.com/udayvir-singh/tangerine.nvim/issues/20> for more
information. > - If you are using rocks.nvim
<https://github.com/nvim-neorocks/rocks.nvim>, there is no need to bootstrap
this plugin (unless you want to write your rocks.nvim bootstrap script in
Fennel). Install with `:Rocks install tangerine.nvim` and skip to step 2.

>lua
-- ~/.config/nvim/plugin/0-tangerine.lua or ~/.config/nvim/init.lua
Expand Down