Add CI update to Lua update documentation

This commit is contained in:
P. J. McDermott 2024-02-12 22:19:40 -05:00 committed by Pentarctagon
parent ec1c336078
commit 0ec656d9c7
2 changed files with 6 additions and 2 deletions

View file

@ -1,7 +1,9 @@
When updating the Lua submodule to a new major/minor version (e.g. 5.4 to 5.5), please also update the system Lua checks in the build systems. When updating the Lua submodule to a new major/minor version (e.g. 5.4 to 5.5), please also update the system Lua checks in the build systems and CI.
Download new versions of <https://gitlab.kitware.com/cmake/cmake/-/raw/master/Modules/FindPackageMessage.cmake> and <https://gitlab.kitware.com/cmake/cmake/-/raw/master/Modules/FindPackageHandleStandardArgs.cmake> to cmake/. Download new versions of <https://gitlab.kitware.com/cmake/cmake/-/raw/master/Modules/FindPackageMessage.cmake> and <https://gitlab.kitware.com/cmake/cmake/-/raw/master/Modules/FindPackageHandleStandardArgs.cmake> to cmake/.
Update cmake/FindLua.cmake from <https://gitlab.kitware.com/cmake/cmake/-/raw/master/Modules/FindLua.cmake> and cherry pick the Wesnoth commit "Modify FindLua.cmake to find Lua compiled as C++". Update cmake/FindLua.cmake from <https://gitlab.kitware.com/cmake/cmake/-/raw/master/Modules/FindLua.cmake> and cherry pick the Wesnoth commit "Modify FindLua.cmake to find Lua compiled as C++".
In CMakeLists.txt, update `set(Lua_FIND_VERSION_MAJOR 5)` and `set(Lua_FIND_VERSION_MINOR 4)`. In SConstruct, update `lua_ver = "5.4"`. In CMakeLists.txt, update `set(Lua_FIND_VERSION_MAJOR 5)` and `set(Lua_FIND_VERSION_MINOR 4)`. In SConstruct, update `lua_ver = "5.4"`.
In .github/workflows/codeql.yml, update `liblua5.4-dev`.

View file

@ -39,10 +39,12 @@ From the repository root, change directory to the lua submodule, and checkout ve
$ cd src/modules/lua $ cd src/modules/lua
$ git checkout tags/v5.4.4 $ git checkout tags/v5.4.4
## 4) Update SCons and CMake ## 4) Update SCons, CMake, and CI
In CMakeLists.txt, update `set(Lua_FIND_VERSION_MAJOR 5)` and `set(Lua_FIND_VERSION_MINOR 4)`. In SConstruct, update `lua_ver = "5.4"` (i.e. "MAJOR.MINOR"). In CMakeLists.txt, update `set(Lua_FIND_VERSION_MAJOR 5)` and `set(Lua_FIND_VERSION_MINOR 4)`. In SConstruct, update `lua_ver = "5.4"` (i.e. "MAJOR.MINOR").
In .github/workflows/codeql.yml, update `liblua5.4-dev`.
Remember to review the source kit for added and removed files, and change the SCons and CMake configuration, as needed. Remember to review the source kit for added and removed files, and change the SCons and CMake configuration, as needed.
Both build systems' build lists are in `~/wesnoth/source_lists/lua`. Both build systems' build lists are in `~/wesnoth/source_lists/lua`.
Verify the files listed match the C source files in the submodule; order is not important, headers are not listed. Verify the files listed match the C source files in the submodule; order is not important, headers are not listed.