Skip to content

Commit e390137

Browse files
ColinKennedyColinKennedy
committed
feat(all)!: removed git submodule history
docs(news): added information about the new, breaking changes ci(llscheck): fixed `Warning: Failed searching manifest: ...` error ci(test): updated tests to use the latest standard
1 parent 30853c4 commit e390137

File tree

10 files changed

+204
-515
lines changed

10 files changed

+204
-515
lines changed

‎.busted‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ return {
55
lua = "nlua",
66
},
77
default = {
8+
helper = "./spec/minimal_init.lua",
89
verbose = true,
910
},
1011
tests = {

‎.github/workflows/documentation.yml‎

Lines changed: 54 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,67 @@ on:
66
- main
77

88
jobs:
9-
documentation:
10-
name: Documentation
9+
check_documentation_branch:
10+
name: Check For A Documentation Branch
1111
runs-on: ubuntu-latest
12+
outputs:
13+
exists: ${{ steps.check_branch.outputs.exists }}
1214
steps:
1315
- name: Checkout repository
14-
uses: actions/checkout@v4
16+
uses: actions/checkout@v5
1517

16-
- uses: rhysd/action-setup-vim@v1
18+
- name: Check If A Valid Documentation Branch Exists
19+
id: check_branch
20+
run: |
21+
if git ls-remote --exit-code origin refs/heads/gh-pages; then
22+
echo "The branch exists"
23+
echo "exists=true" >> $GITHUB_OUTPUT
24+
else
25+
echo "The branch does not exist"
26+
echo "exists=false" >> $GITHUB_OUTPUT
27+
fi
28+
29+
html_documentation:
30+
needs: check_documentation_branch
31+
if: needs.check_documentation_branch.outputs.exists == 'true'
32+
name: HTML Documentation
33+
runs-on: ubuntu-latest
34+
steps:
35+
- name: Checkout repository
36+
uses: actions/checkout@v5
37+
38+
- name: Install emmylua_doc_cli From crates.io
39+
uses: baptiste0928/cargo-install@v3
40+
with:
41+
crate: emmylua_doc_cli
42+
43+
- name: Generate Mkdocs Files With emmylua_doc_cli
44+
run: emmylua_doc_cli --input lua/ --output markdown/generated --mixin markdown/manual
45+
46+
- name: Deploy To GitHub Pages
47+
uses: mhausenblas/[email protected]
48+
env:
49+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
50+
CONFIG_FILE: markdown/generated/mkdocs.yml
51+
52+
vim_documentation:
53+
name: Vim Documentation
54+
runs-on: ubuntu-latest
55+
steps:
56+
- name: Checkout repository
57+
uses: actions/checkout@v5
58+
59+
- name: Install Neovim
60+
uses: rhysd/action-setup-vim@v1
1761
with:
1862
neovim: true
1963
version: stable
2064

65+
- name: Create API Documentation
66+
run: |
67+
nvim --version
68+
make api-documentation
69+
2170
- name: Create User Documentation
2271
uses: kdheepak/panvimdoc@main
2372
with:
@@ -31,7 +80,7 @@ jobs:
3180
nvim -c 'helptags doc' -c 'quit'
3281
3382
- name: Push Changes
34-
uses: stefanzweifel/git-auto-commit-action@v5
83+
uses: stefanzweifel/git-auto-commit-action@v6
3584
with:
3685
commit_message: "docs(vimdoc): Auto-generate user / API documentation + vimtags"
3786
commit_user_name: "github-actions[bot]"

‎.github/workflows/llscheck.yml‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,19 @@ jobs:
1515
name: llscheck
1616

1717
steps:
18-
- uses: actions/checkout@master
18+
- name: Checkout
19+
uses: actions/checkout@master
1920

20-
- uses: rhysd/action-setup-vim@v1
21+
- name: Install Neovim
22+
uses: rhysd/action-setup-vim@v1
2123
# NOTE: We need Neovim installed in order to expose the $VIMRUNTIME
2224
# environment variable
2325
with:
2426
neovim: true
2527
version: stable
2628

27-
- uses: leafo/gh-actions-lua@v10
29+
- name: Install A Lua Interpreter
30+
uses: leafo/gh-actions-lua@v11
2831
with:
2932
# Neovim is compiled with LuaJIT so we might as well match. But it
3033
# doesn't look like we can match it exactly.
@@ -40,30 +43,27 @@ jobs:
4043
tool_versions: |
4144
lua-language-server latest
4245
43-
- uses: leafo/gh-actions-luarocks@v4
44-
- name: Install llscheck
45-
run: |
46-
luarocks install llscheck
47-
luarocks install nlua
48-
49-
- name: Clone dependencies - busted
50-
uses: actions/checkout@v4
51-
with:
52-
repository: "LuaCATS/busted"
53-
path: ".dependencies/busted"
46+
- name: Install luarocks
47+
# TODO: Replace with https://github.com/luarocks/gh-actions-luarocks after v6+
48+
uses: ColinKennedy/[email protected]
5449

55-
- name: Clone dependencies - luassert
56-
uses: actions/checkout@v4
57-
with:
58-
repository: "LuaCATS/luassert"
59-
path: ".dependencies/luassert"
50+
- name: Print Versions
51+
run: |
52+
luarocks --version
53+
lua-language-server --version
6054
61-
- name: Clone dependencies - luavit-meta
62-
uses: actions/checkout@v4
63-
with:
64-
repository: "Bilal2453/luvit-meta"
65-
path: ".dependencies/luvit-meta"
55+
- name: Install llscheck
56+
run: |
57+
luarocks --version
58+
luarocks install llscheck --verbose
6659
67-
- name: test
60+
- name: Test
6861
run: |
69-
VIMRUNTIME=`nlua -e 'io.write(os.getenv("VIMRUNTIME"))'` llscheck --configpath .github/workflows/.luarc.json .
62+
# We use SSH in the `Makefile` but GitHub actions don't allow that. So
63+
# we force git to clone using HTTP instead.
64+
#
65+
export GIT_CONFIG=~/.gitconfig
66+
git config url."https://github.com/".insteadOf [email protected]:
67+
68+
# Now do the llscheck (and any git clones, as needed)
69+
make llscheck CONFIGURATION=.github/workflows/.luarc.json

‎.github/workflows/test.yml‎

Lines changed: 51 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,35 +14,69 @@ jobs:
1414
strategy:
1515
matrix:
1616
os: [ubuntu-latest, macos-latest]
17-
neovim: [v0.10.0, stable, nightly]
17+
neovim: [v0.10.0, v0.11.0, stable, nightly]
18+
luaVersion: ["luajit-openresty"]
19+
include:
20+
- os: "windows-latest"
21+
toolchain: "msvc"
22+
luaVersion: "5.1"
23+
neovim: "v0.10.0"
24+
- os: "windows-latest"
25+
toolchain: "msvc"
26+
luaVersion: "5.1"
27+
neovim: "stable"
28+
- os: "windows-latest"
29+
toolchain: "msvc"
30+
luaVersion: "5.1"
31+
neovim: "nightly"
1832

1933
runs-on: ${{ matrix.os }}
20-
name: "OS: ${{ matrix.os }} - Neovim: ${{ matrix.neovim }}"
34+
name: "OS: ${{ matrix.os }} - Neovim: ${{ matrix.neovim }} - Lua: ${{ matrix.luaVersion }}"
2135

2236
steps:
23-
- uses: actions/checkout@master
37+
- name: Checkout
38+
uses: actions/checkout@master
2439

25-
- uses: leafo/gh-actions-lua@v10
40+
- name: Install Neovim
41+
uses: rhysd/action-setup-vim@v1
2642
with:
27-
# Neovim is compiled with LuaJIT so we might as well match. But it
28-
# doesn't look like we can match it exactly.
29-
#
30-
# Reference:
31-
# https://github.com/leafo/gh-actions-lua/issues/49#issuecomment-2295071198
32-
#
33-
luaVersion: "luajit-openresty"
43+
neovim: true
44+
version: ${{ matrix.neovim }}
3445

35-
- uses: leafo/gh-actions-luarocks@v4
46+
- name: Setup MSVC
47+
# the 'luarocks/gh-actions-lua' step requires msvc to build PUC-Rio Lua
48+
# versions on Windows (LuaJIT will be build using MinGW/gcc).
49+
if: ${{ matrix.toolchain == 'msvc' }}
50+
uses: ilammy/msvc-dev-cmd@v1
3651

37-
- uses: rhysd/action-setup-vim@v1
52+
- name: Install Lua
53+
uses: luarocks/gh-actions-lua@v11
3854
with:
39-
neovim: true
40-
version: ${{ matrix.neovim }}
55+
luaVersion: "${{ matrix.luaVersion }}"
56+
57+
- name: Install LuaRocks
58+
# TODO: Replace with https://github.com/luarocks/gh-actions-luarocks after v6+
59+
uses: ColinKennedy/[email protected]
60+
61+
- name: Print Versions
62+
run: |
63+
luarocks --version
64+
65+
# We need this hack until a better solution is available.
66+
#
67+
# Reference: https://github.com/nvim-neorocks/luarocks-tag-release/issues/435
68+
#
69+
- name: Expand The Template Rockspec
70+
uses: ColinKennedy/[email protected]
71+
with:
72+
input: template.rockspec
73+
output: cursor-text-objects-scm-1.rockspec
74+
delete_input_after: true
4175

42-
- name: build
76+
- name: Build Test Dependencies
4377
run: |
4478
luarocks test cursor-text-objects-scm-1.rockspec --prepare
4579
46-
- name: test
80+
- name: Test
4781
run: |
4882
luarocks test --test-type busted

‎Makefile‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,25 @@ else
99
IGNORE_EXISTING = 2> /dev/null || true
1010
endif
1111

12-
clone_git_dependencies:
12+
CONFIGURATION = .luarc.json
13+
14+
download-dependencies:
1315
git clone [email protected]:LuaCATS/busted.git .dependencies/busted $(IGNORE_EXISTING)
1416
git clone [email protected]:LuaCATS/luassert.git .dependencies/luassert $(IGNORE_EXISTING)
1517
git clone [email protected]:Bilal2453/luvit-meta.git .dependencies/luvit-meta $(IGNORE_EXISTING)
1618

17-
api_documentation:
19+
api-documentation:
1820
nvim -u scripts/make_api_documentation/minimal_init.lua -l scripts/make_api_documentation/main.lua
1921

20-
llscheck: clone_git_dependencies
21-
VIMRUNTIME=`nlua -e 'io.write(os.getenv("VIMRUNTIME"))'` llscheck --configpath .luarc.json .
22+
llscheck: download-dependencies
23+
VIMRUNTIME="`nvim --clean --headless --cmd 'lua io.write(os.getenv("VIMRUNTIME"))' --cmd 'quit'`" llscheck --configpath $(CONFIGURATION) .
24+
2225

2326
luacheck:
2427
luacheck lua plugin scripts spec
2528

2629
stylua:
2730
stylua lua plugin scripts spec
2831

29-
test: clone_git_dependencies
32+
test: download-dependencies
3033
busted --helper spec/minimal_init.lua .

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Give your right-pinky a workout and install `cursor-text-objects.nvim` today!
9090
{ desc = "Run from your current cursor to the end of the text-object." }
9191
)
9292
end,
93-
version = "v1.*",
93+
version = "v2.*",
9494
}
9595
```
9696

‎cursor-text-objects-scm-1.rockspec‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎doc/news.txt‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
*cursor-text-objects-news.txt*
22

3-
Notable changes since CursorTextObjects 1.0
3+
Notable changes since CursorTextObjects 2.0
44

55

66
===============================================================================
77
NEW FEATURES *cursor-text-objects-new-features*
88

9-
- Added default `<Plug>` mappings
9+
- n/a
1010

1111

1212
===============================================================================
1313
BREAKING CHANGES *cursor-text-objects-new-breaking*
1414

15-
n/a
15+
The git history was squashed so lazy.nvim will load the plugin properly.
16+
17+
The original plugin history is retained in a backup branch called `v1_backup`
18+
and all `v1.*` tagged commits are still accessible.
19+
20+
See: https://github.com/ColinKennedy/cursor-text-objects.nvim/issues/10
1621

1722

1823
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)