Add Generate SWIG files GHA that can be used to quickly generate code (#565)

* Initial generate swig workflow

* Update generate_swig.yml

* Add gen_swig_only flag

* Add cmake target logic

* Update build_zips.py

* Try not requiring Unity

* Update generate_swig.yml

* Update FindUnity.cmake

* Update FindUnity.cmake

* Add more logic to

* Updates to not need Unity

* Update generate_swig.yml

* Update the other products

Author: a-maurice

.github/workflows/generate_swig.yml

@@ -14,20 +14,11 @@ on:
         default: ''
         required: false
         type: string
-      unity_branch:
-        description: 'Unity branch to build against, empty means current branch'
-        default: ''
-        type: string
       apis:
         description: 'CSV of apis to build and test'
         default: 'analytics,auth,crashlytics,database,dynamic_links,firestore,functions,installations,messaging,remote_config,storage'
         required: true
         type: string
-      unity_platform_name:
-        description: 'The platform name Unity should install with'
-        default: ''
-        required: true
-        type: string
       # Additional CMake flags to use
       additional_cmake_flags:
         description: 'Additional flags to pass into CMake'
@@ -46,7 +37,6 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: true
-          ref: ${{ inputs.unity_branch }}
 
       - uses: actions/checkout@v3
         with:
@@ -77,13 +67,6 @@ jobs:
         run: |
           sudo apt install openssl
 
-      - id: unity_setup
-        uses: ./gha/unity
-        timeout-minutes: 30
-        with:
-          version: ${{ inputs.unity_version }}
-          platforms: ${{ inputs.unity_platform_name }}
-
       - name: Setup Swig Env
         shell: bash
         run: |
@@ -96,30 +79,18 @@ jobs:
         shell: bash
         run: |
           # TODO add handling cmake_extras
-          python scripts/build_scripts/build_zips.py --gha --platform=linux --use_boringssl=true --unity_root=$UNITY_ROOT_DIR --apis=${{ inputs.apis }} --gen_documentation_zip
+          python scripts/build_scripts/build_zips.py --gha --platform=linux --apis=${{ inputs.apis }} --gen_swig_only
       
       - name: Check zip files
         shell: bash
         run: |
-          if [ -f linux_unity/*Linux.zip ]; then
-            echo "linux_unity zip created."
-          else
-            echo "Fail to create linux_unity zip."
-            exit 1
-          fi
           if [ -f linux_unity/documentation_sources.zip ]; then
             echo "documentation_sources zip created."
           else
             echo "Fail to create documentation_sources zip."
             exit 1
           fi
 
-      - name: Upload Build
-        uses: actions/upload-artifact@v3
-        with:
-          name: linux_unity
-          path: linux_unity/*Linux.zip
-
       - name: Upload Documentation Sources
         uses: actions/upload-artifact@v3
         with:

CMakeLists.txt

@@ -75,6 +75,9 @@ option(FIREBASE_UNITY_BUILD_TESTS
 option(FIREBASE_GITHUB_ACTION_BUILD
        "Indicates that this build was created from a GitHub Action" OFF)
 
+option(FIREBASE_GENERATE_SWIG_ONLY
+       "Indicates that this build is only intending to generate the swig files" OFF)
+
 # These options allow selecting what built outputs go into the CPack zip file
 # as we merge the different platform zip's together for unity package
 # For example: only packing dotnet libraries on linux builds
@@ -242,11 +245,12 @@ endif()
 # Includes platform which needs to be invoked first
 add_subdirectory(app)
 set(TARGET_LINK_LIB_NAMES "firebase_app" "firebase_app_swig")
+set(DOCUMENTATION_ONLY_LIB_NAMES "firebase_app_swig")
 set(PROJECT_LIST_HEADER "#define PROJECT_LIST(X)")
 list(APPEND PROJECT_LIST_HEADER "  X(App)")
 
 # Include Firebase editor tools.
-if (DESKTOP AND APPLE AND FIREBASE_INCLUDE_EDITOR_TOOL)
+if (DESKTOP AND APPLE AND FIREBASE_INCLUDE_EDITOR_TOOL AND NOT FIREBASE_GENERATE_SWIG_ONLY)
   add_subdirectory(editor)
 endif()
 
@@ -258,56 +262,67 @@ endif()
 if (FIREBASE_INCLUDE_ANALYTICS)
   add_subdirectory(analytics)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_analytics" "firebase_analytics_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_analytics_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(Analytics)")
 endif()
 if (FIREBASE_INCLUDE_AUTH)
   add_subdirectory(auth)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_auth" "firebase_auth_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_auth_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(Auth)")
 endif()
 if (FIREBASE_INCLUDE_CRASHLYTICS AND FIREBASE_INCLUDE_UNITY)
   add_subdirectory(crashlytics)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_crashlytics" "firebase_crashlytics_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_crashlytics_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(Crashlytics)")
 endif()
 if (FIREBASE_INCLUDE_DATABASE)
   add_subdirectory(database)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_database" "firebase_database_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_database_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(Database)")
 endif()
 if (FIREBASE_INCLUDE_DYNAMIC_LINKS)
   add_subdirectory(dynamic_links)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_dynamic_links" "firebase_dynamic_links_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_dynamic_links_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(DynamicLinks)")
 endif()
 if (FIREBASE_INCLUDE_INSTALLATIONS)
   add_subdirectory(installations)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_installations" "firebase_installations_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_installations_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(Installations)")
 endif()
 if (FIREBASE_INCLUDE_FIRESTORE)
   add_subdirectory(firestore)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_firestore" "firebase_firestore_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_firestore_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(Firestore)")
 endif()
 if (FIREBASE_INCLUDE_FUNCTIONS)
   add_subdirectory(functions)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_functions" "firebase_functions_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_functions_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(Functions)")
 endif()
 if (FIREBASE_INCLUDE_MESSAGING)
   add_subdirectory(messaging)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_messaging" "firebase_messaging_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_messaging_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(Messaging)")
 endif()
 if (FIREBASE_INCLUDE_REMOTE_CONFIG)
   add_subdirectory(remote_config)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_remote_config" "firebase_remote_config_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_remote_config_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(RemoteConfig)")
 endif()
 if (FIREBASE_INCLUDE_STORAGE)
   add_subdirectory(storage)
   list(APPEND TARGET_LINK_LIB_NAMES "firebase_storage" "firebase_storage_swig")
+  list(APPEND DOCUMENTATION_ONLY_LIB_NAMES "firebase_storage_swig")
   list(APPEND PROJECT_LIST_HEADER "  X(Storage)")
 endif()
 
@@ -322,6 +337,11 @@ if(FIREBASE_UNI_LIBRARY)
   endif()
 endif()
 
+add_custom_target(firebase_swig_targets
+  DEPENDS
+    ${DOCUMENTATION_ONLY_LIB_NAMES}
+)
+
 if(FIREBASE_INCLUDE_MONO)
   add_subdirectory(samples/mono_app)
 endif()

analytics/CMakeLists.txt

@@ -36,6 +36,19 @@ firebase_swig_add_library(firebase_analytics_swig
     firebase_analytics
 )
 
+unity_pack_documentation_sources(analytics
+  DOCUMENTATION_SOURCES
+    ${firebase_analytics_src}
+    ${firebase_analytics_swig_gen_src}
+)
+if (FIREBASE_GENERATE_SWIG_ONLY)
+  unity_pack_documentation_sources(analytics
+    DOCUMENTATION_SOURCES
+      ${firebase_analytics_swig_gen_cpp_src}
+  )
+  return()
+endif()
+
 mono_add_library(firebase_analytics_cs
   MODULE
     Firebase.Analytics
@@ -71,12 +84,6 @@ if (FIREBASE_INCLUDE_UNITY)
   )
 endif()
 
-unity_pack_documentation_sources(analytics
-  DOCUMENTATION_SOURCES
-    ${firebase_analytics_src}
-    ${firebase_analytics_swig_gen_src}
-)
-
 set_property(TARGET firebase_analytics_cs
   PROPERTY FOLDER
   "Firebase ${FIREBASE_PLATFORM_NAME}"

app/CMakeLists.txt

@@ -23,8 +23,10 @@ else()
   set(firebase_platform_task_lib "")
 endif()
 
-add_subdirectory(platform)
-add_subdirectory(task_extension)
+if (NOT FIREBASE_GENERATE_SWIG_ONLY)
+  add_subdirectory(platform)
+  add_subdirectory(task_extension)
+endif()
 
 set(FIREBASE_PLATFORM_REF
   "firebase_app_cs"
@@ -81,6 +83,20 @@ firebase_swig_add_library(firebase_app_swig
     firebase_app
 )
 
+unity_pack_documentation_sources(app
+  DOCUMENTATION_SOURCES
+    ${firebase_app_src_documented}
+    ${firebase_app_swig_gen_src}
+    task_extension/TaskExtension.cs
+)
+if (FIREBASE_GENERATE_SWIG_ONLY)
+  unity_pack_documentation_sources(app
+    DOCUMENTATION_SOURCES
+      ${firebase_app_swig_gen_cpp_src}
+  )
+  return()
+endif()
+
 if(FIREBASE_UNI_LIBRARY AND NOT FIREBASE_IOS_BUILD)
   set(firebase_native_library firebase_app_uni)
 else()
@@ -115,13 +131,6 @@ if (FIREBASE_INCLUDE_UNITY)
   )
 endif()
 
-unity_pack_documentation_sources(app
-  DOCUMENTATION_SOURCES
-    ${firebase_app_src_documented}
-    ${firebase_app_swig_gen_src}
-    task_extension/TaskExtension.cs
-)
-
 set_property(TARGET firebase_app_cs
   PROPERTY FOLDER
   "Firebase ${FIREBASE_PLATFORM_NAME}"

auth/CMakeLists.txt

@@ -50,6 +50,19 @@ firebase_swig_add_library(firebase_auth_swig
     ${EXTERNAL_LIB_NAMES}
 )
 
+unity_pack_documentation_sources(auth
+  DOCUMENTATION_SOURCES
+    ${firebase_auth_src}
+    ${firebase_auth_swig_gen_src}
+)
+if (FIREBASE_GENERATE_SWIG_ONLY)
+  unity_pack_documentation_sources(auth
+    DOCUMENTATION_SOURCES
+      ${firebase_auth_swig_gen_cpp_src}
+  )
+  return()
+endif()
+
 mono_add_library(firebase_auth_cs
   MODULE
     Firebase.Auth
@@ -85,12 +98,6 @@ if (FIREBASE_INCLUDE_UNITY)
   )
 endif()
 
-unity_pack_documentation_sources(auth
-  DOCUMENTATION_SOURCES
-    ${firebase_auth_src}
-    ${firebase_auth_swig_gen_src}
-)
-
 set_property(TARGET firebase_auth_cs
   PROPERTY FOLDER
   "Firebase ${FIREBASE_PLATFORM_NAME}"

cmake/FindUnity.cmake

@@ -16,6 +16,10 @@
 
 find_package(Mono REQUIRED)
 
+if (FIREBASE_GENERATE_SWIG_ONLY)
+  return()
+endif()
+
 if (NOT EXISTS "${UNITY_ROOT_DIR}")
   # Make our best attempt to find the latest unity installed on the system.
   # Note that Unity <=2018 include mono 2.x which causes compilation errors.

cmake/unity_mono.cmake

@@ -146,6 +146,11 @@ endmacro()
 #
 macro(mono_add_external_dll name dllpath)
 
+  if(FIREBASE_GENERATE_SWIG_ONLY)
+    add_custom_target(${name})
+    return()
+  endif()
+
   if(NOT EXISTS ${dllpath})
     message(FATAL_ERROR "Expected ${name} file to already exist for mono_add_external_dll(${dllpath})")
   endif()
@@ -210,14 +215,18 @@ endmacro()
 #  * If no guid is provided a new guid will be generated each time
 #
 macro(mono_add_library name)
-  mono_add_internal(${name} "Library" ${ARGN})
-  set_target_properties(${name} PROPERTIES FOLDER "Mono Dll")
+  if (NOT FIREBASE_GENERATE_SWIG_ONLY)
+    mono_add_internal(${name} "Library" ${ARGN})
+    set_target_properties(${name} PROPERTIES FOLDER "Mono Dll")
+  endif()
 endmacro()
 
 # Creates and executable library. See mono_add_library for args
 macro(mono_add_executable name)
-  mono_add_internal(${name} "Exe" ${ARGN})
-  set_target_properties(${name} PROPERTIES FOLDER "Mono Bin")
+  if (NOT FIREBASE_GENERATE_SWIG_ONLY)
+    mono_add_internal(${name} "Exe" ${ARGN})
+    set_target_properties(${name} PROPERTIES FOLDER "Mono Bin")
+  endif()
 endmacro()
 
 # Internal helper function for mono_add_library and mono_add_executable

crashlytics/CMakeLists.txt

@@ -80,6 +80,19 @@ firebase_swig_add_library(firebase_crashlytics_swig
     ${EXTERNAL_LIB_NAMES}
 )
 
+unity_pack_documentation_sources(crashlytics
+  DOCUMENTATION_SOURCES
+    ${firebase_crashlytics_src_documented}
+)
+if (FIREBASE_GENERATE_SWIG_ONLY)
+  unity_pack_documentation_sources(crashlytics
+    DOCUMENTATION_SOURCES
+      ${firebase_crashlytics_swig_gen_src}
+      ${firebase_crashlytics_swig_gen_cpp_src}
+  )
+  return()
+endif()
+
 mono_add_library(firebase_crashlytics_cs
   MODULE
     Firebase.Crashlytics
@@ -117,11 +130,6 @@ if (FIREBASE_INCLUDE_UNITY)
   )
 endif()
 
-unity_pack_documentation_sources(crashlytics
-  DOCUMENTATION_SOURCES
-    ${firebase_crashlytics_src_documented}
-)
-
 set_property(TARGET firebase_crashlytics_cs
   PROPERTY FOLDER
   "Firebase ${FIREBASE_PLATFORM_NAME}"