feat: use a submodule for ninja sources (#278)

* feat: use a submodule for ninja sources

* fix: respect RUN_NINJA_TEST option

* fix: exclude unneeded files from SDist

SDist goes from ~350kB to ~200kB

Author: mayeut

.github/workflows/build.yml

@@ -64,7 +64,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # required for versioneer to find tags
+          fetch-depth: 0  # required for setuptools_scm to find tags
+          submodules: 'recursive'
 
       - name: Set up QEMU
         uses: docker/[email protected]
@@ -97,7 +98,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # required for versioneer to find tags
+          fetch-depth: 0  # required for setuptools_scm to find tags
+          submodules: 'recursive'
 
       - name: Build SDist
         run: pipx run build --sdist

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ninja-upstream"]
+	path = ninja-upstream
+	url = https://github.com/Kitware/ninja.git

CMakeLists.txt

@@ -5,56 +5,28 @@ project(NinjaPythonDistributions)
 set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_MODULE_PATH})
 
 # Options
-option(BUILD_VERBOSE "Display additional information while building (e.g download progress, ...)" OFF)
-option(RUN_NINJA_TEST "Run Ninja test suite" ON)
-set(ARCHIVE_DOWNLOAD_DIR "${CMAKE_BINARY_DIR}" CACHE PATH "Directory where to download archives")
+option(RUN_NINJA_TEST "Run Ninja test suite" OFF)
 
-include(NinjaUrls)
-
-function(check_archive_var archive_var)
-  if(NOT DEFINED "${archive_var}_url")
-    message(FATAL_ERROR "Failed to determine which archive to download: '${archive_var}_url' variable is not defined")
-  endif()
-  if(NOT DEFINED "${archive_var}_sha256")
-    message(FATAL_ERROR "Could you make sure variable '${archive_var}_sha256' is defined ?")
-  endif()
-endfunction()
-
-set(src_archive "unix_source")
-if(WIN32)
-  set(src_archive "windows_source")
-endif()
-check_archive_var("${src_archive}")
-
-message(STATUS "*********************************************")
+message(STATUS "************************************")
 message(STATUS "Ninja Python Distribution")
 message(STATUS "")
-message(STATUS "  BUILD_VERBOSE             : ${BUILD_VERBOSE}")
-message(STATUS "  RUN_NINJA_TEST            : ${RUN_NINJA_TEST}")
-message(STATUS "")
-message(STATUS "  ARCHIVE_DOWNLOAD_DIR      : ${ARCHIVE_DOWNLOAD_DIR}")
-message(STATUS "")
-message(STATUS "    src_archive             : ${src_archive}")
-message(STATUS "    <src_archive>_url       : ${${src_archive}_url}")
-message(STATUS "    <src_archive>_sha256    : ${${src_archive}_sha256}")
-message(STATUS "*********************************************")
-
-set(ep_download_no_progress_args)
-if(NOT BUILD_VERBOSE)
-  set(ep_download_no_progress_args
-    DOWNLOAD_NO_PROGRESS 1
-    )
-endif()
+message(STATUS "  RUN_NINJA_TEST : ${RUN_NINJA_TEST}")
+message(STATUS "************************************")
 
 include(FetchContent)
 FetchContent_Declare(
   ninja
-  URL ${${src_archive}_url}
-  URL_HASH SHA256=${${src_archive}_sha256}
-  DOWNLOAD_DIR ${ARCHIVE_DOWNLOAD_DIR}
-  ${ep_download_no_progress_args}
+  SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/ninja-upstream
 )
 FetchContent_MakeAvailable(ninja)
 
+if(RUN_NINJA_TEST)
+  add_custom_target(
+    run_ninja_test ALL "$<TARGET_FILE:ninja_test>"
+    DEPENDS ninja_test
+    WORKING_DIRECTORY "$<TARGET_FILE_DIR:ninja_test>"
+  )
+endif()
+
 install(TARGETS ninja COMPONENT python DESTINATION "${SKBUILD_SCRIPTS_DIR}")
 install(FILES "${ninja_SOURCE_DIR}/misc/ninja_syntax.py" COMPONENT python DESTINATION ninja)

NinjaUrls.cmake

@@ -93,16 +93,13 @@ def bump(session: nox.Session) -> None:
     else:
         version = args.version
 
-    deps = nox.project.load_toml("scripts/update_ninja_version.py")["dependencies"]
-    session.install(*deps)
-
     extra = ["--quiet"] if args.commit else []
     session.run("python", "scripts/update_ninja_version.py", "--upstream-repository", args.upstream_repository, version, *extra)
 
     if args.commit:
         session.run("git", "switch", "-c", f"update-to-ninja-{version}", external=True)
         files = (
-            "NinjaUrls.cmake",
+            "ninja-upstream",
             "README.rst",
             "tests/test_ninja.py",
             "docs/update_ninja_version.rst",

constraints.txt

@@ -58,6 +58,7 @@ wheel.expand-macos-universal-tags = true
 metadata.version.provider = "scikit_build_core.metadata.setuptools_scm"
 metadata.readme.provider = "scikit_build_core.metadata.fancy_pypi_readme"
 install.components = ["python"]
+sdist.exclude = ["**/.github", "/noxfile.py", "/ninja-python-distributions-logo.png", "/docs", "/scripts", "/ninja-upstream/doc", "!/ninja-upstream/misc", "/ninja-upstream/misc/**", "!/ninja-upstream/misc/ninja_syntax.py"]
 
 
 [[tool.scikit-build.generate]]
@@ -98,6 +99,13 @@ musllinux-ppc64le-image = "musllinux_1_1"
 musllinux-s390x-image = "musllinux_1_1"
 musllinux-armv7l-image = "musllinux_1_2"
 
+[tool.cibuildwheel.config-settings]
+"cmake.define.RUN_NINJA_TEST" = "ON"
+
+[[tool.cibuildwheel.overrides]]
+select = ["*-win_arm64",]
+config-settings."cmake.define.RUN_NINJA_TEST" = "OFF"
+
 [[tool.cibuildwheel.overrides]]
 select = "*-macos*"
 inherit.environment = "append"