Publishes packages to LuaRocks when a git tag is pushed. No need to add a rockspec to your repository for each release (or at all).
Create .github/workflows/release.yml
in your repository with the following contents:
name: LuaRocks release
on:
push:
tags: # Will upload to luarocks.org when a tag is pushed
- "*"
pull_request: # Will test a local install without uploading to luarocks.org
jobs:
luarocks-release:
runs-on: ubuntu-latest
name: LuaRocks upload
steps:
- name: Checkout
uses: actions/checkout@v3
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
env:
LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
[!NOTE]
Use the
v7
tag to keep up with the latest releases, without breaking changes.
The following optional inputs can be specified using with:
name
The name of the the luarocks package.
dependencies
Lua dependencies. Any dependencies specified here must be available on LuaRocks.
Example:
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
with:
dependencies: |
plenary.nvim
telescope.nvim
test_dependencies
Lua dependencies of the test suite. Any dependencies specified here must be available on LuaRocks.
Example:
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
with:
test_dependencies: |
luaunit
labels
Labels to add to the rockspec. If none are specified, this action will use the repository's GitHub topics.
Example:
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
with:
labels: |
neovim
copy_directories
Directories in the source directory to be copied to the rock installation prefix as-is. Useful for installing documentation and other files such as samples and tests.
Example:
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
with:
copy_directories: |
{{ neovim.plugin.dirs }}
src
examples
[!NOTE]
The value
{{ neovim.plugin.dirs }}
(set by default) expands to common Neovim plugin directories (see also:help runtimepath
):
- autoload
- colors
- compiler
- doc
- filetype.lua
- ftplugin
- ftdetect
- indent
- keymap
- lang
- menu.vim
- parser
- plugin
- queries
- query
- rplugin
- spell
- syntax
[!WARNING]
Do not use the following directory names:
lua
,lib
,rock_manifest
or the name of your rockspec; those names are used by the .rock format internally, and attempting to copy directories with those names using the build.copy_directories directive will cause a clash.
summary
A short description of the package (one line). If excluded, this action will fetch it from your repository's about section.
detailed_description
A more detailed description of the package. Can be multiple lines.
Example:
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
with:
detailed_description: |
Publishes packages to LuaRocks when a git tag is pushed.
Automatically generates a rockspec from repository metadata
and tests the installation before releasing.
template
By default, this workflow will generate a rockspec based on a predefined template.
You can also add a modified template to your repository and specify the path
to it with the template
variable.
Example:
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
with:
template: "/path/to/my/template.rockspec"
license
(optional)The license used by this package. If not set (by default), this workflow will fetch the license SPDX ID from GitHub. If GitHub cannot detect the license automatically, you can set it here.
Example:
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
with:
license: "MIT"
[!NOTE]
If GitHub can detect the license automatically, it will be displayed in your repository's About section.
version
(optional)The package version to release to LuaRocks (without the rockspec revision).
By default, this workflow will use github.ref_name
(the git tag or branch name)
to determine the LuaRocks package version.
If you do not have a workflow that releases based on tags,
you can manually set the version input.
Setting this input to either null
, "scm"
or "dev"
will result in a
scm release, where the generated rockspec's source URL
is the repository's URL.
The following is an example for a basic workflow that runs daily at 00:00,
sets the package version to 0.0.<number_of_commits>
, and publishes to LuaRocks
if there have been any commits in the last 24 hours:
name: "release"
on:
workflow_dispatch: # allows manual triggering
schedule:
- cron: '0 0 * * *' # runs daily at 00:00
pull_request: # Will test a local install without uploading to luarocks.org
jobs:
luarocks-upload:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0 # Required to count the commits
- name: Set luarocks version
run: echo "LUAROCKS_VERSION=0.0.$(git log --oneline | wc -l)" >> $GITHUB_ENV
- name: Get new commits
run: echo "NEW_COMMIT_COUNT=$(git log --oneline --since '24 hours ago' | wc -l)" >> $GITHUB_ENV
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
if: ${{ env.NEW_COMMIT_COUNT > 0 }}
env:
LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
with:
version: ${{ env.LUAROCKS_VERSION }}
[!NOTE]
A
v
prefix (e.g. git tags such asv1.0.0
) is also supported. It will be removed from the LuaRocks version.
specrev
(optional)The specrev (revision) of the generated rockspec. Defaults to '1'
.
[!TIP]
When publishing
scm
ordev
rockspecs, it can be useful to set point the source to a commit hash, and increment thespecrev
with every new push. This allows consumers to roll back or pin dev versions.
Example:
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
with:
version: "scm"
# Add logic or determining if the specrev needs to be incremented
specrev: "${{ env.SPECREV }}"
fail_on_duplicate
(optional)When set to true
will cause the workflow to fail with an error if the rock already exists on the server.
By default, if the rock already exists with a given version, the workflow will do nothing and fall back to other tasks
instead (e.g. running tests).
extra_luarocks_args
Extra args to pass to the luarocks command. This is useful if luarocks cannot find headers needed for the installation.
Example:
- run: |
sudo apt-get install -y libcurl4-openssl-dev
- name: LuaRocks Upload
uses: nvim-neorocks/luarocks-tag-release@v7
with:
extra_luarocks_args: |
CURL_INCDIR=/usr/include/x86_64-linux-gnu
[!TIP]
To find out where
apt
installs headers (assuming you are have setruns-on: ubuntu-xyz
), you can rundpkg -L <package-name>
.
See the Example configurations wiki page.
rocks.nvim
:
A modern approach to Neovim plugin management, which uses
luarocks.Thanks to: