Skip to content

Commit a356c9b

Browse files
committed
CI: Check that Vim help tags in runtime folder are correct
Previously, Vim didn't always have up-to-date help tags. As a result, we just manually generate the help tags when publishing a release (#1286), even though it doesn't actually make sure the tags file in source is actually accurate. However, Vim has since added CI checks to make sure the help tags are correct, so we can change MacVim CI to do the same thing as well. This way, the source version is always correct and we won't rely on a build step during release to fix it, and it also makes sure other methods to get MacVim (build from source, Homebrew) will be correct as well.
1 parent a26996d commit a356c9b

1 file changed

Lines changed: 9 additions & 21 deletions

File tree

.github/workflows/ci-macvim.yaml

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ jobs:
5353
# Oldest version of Xcode supported on GitHub Action to test source code backwards compatibility
5454
- os: macos-11
5555
xcode: '11.7'
56+
extra: [vimtags]
5657

5758
# Older version of Xcode, and used to publish legacy builds (for macOS 10.9 - 10.12)
5859
- os: macos-12
@@ -221,27 +222,7 @@ jobs:
221222
cat src/auto/config.mk
222223
cat src/auto/config.h
223224
224-
# Build Vim first, separately from MacVim, so that we can use it to run
225-
# vimtags afterwards to get the most correct help tags before we copy
226-
# that into the MacVim bundle.
227-
- name: Build Vim
228-
env:
229-
LC_ALL: C
230-
run: |
231-
set -o verbose
232-
233-
NPROC=$(getconf _NPROCESSORS_ONLN)
234-
echo "Building Vim with ${NPROC} cores"
235-
236-
make -C src -j${NPROC} Vim
237-
238-
# Re-generate Vim help tags, because sometimes the Vim's runtime is not
239-
# updated to have the latest tags.
240-
- name: Update Vim help tags
241-
if: matrix.publish
242-
run: make -C runtime/doc vimtags VIMEXE=../../src/vim
243-
244-
- name: Build MacVim
225+
- name: Build
245226
env:
246227
LC_ALL: C
247228
run: |
@@ -313,6 +294,13 @@ jobs:
313294
check_arch "${VIM_BIN}"
314295
check_arch "${MACVIM_BIN}"
315296
297+
- name: Check Vim help tags
298+
if: contains(matrix.extra, 'vimtags')
299+
run: |
300+
# Confirm that we can build the help tags, and they match what's in source.
301+
make -C runtime/doc vimtags VIMEXE=../../${VIM_BIN}
302+
git diff --exit-code -- runtime/doc/tags
303+
316304
- name: Test
317305
timeout-minutes: 20
318306
run: make test

0 commit comments

Comments
 (0)