v1.1.0

Author: sharplet

.gitmodules

@@ -4,3 +4,4 @@
 [submodule "iSSH2"]
 	path = iSSH2
 	url = https://github.com/sharplet/iSSH2.git
+	branch = main

.swiftlint.yml

@@ -0,0 +1,2 @@
+trailing_comma:
+  mandatory_comma: true

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 Adam Sharp.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Package.swift

@@ -4,6 +4,13 @@ import PackageDescription
 
 let package = Package(
   name: "swift-cgit2",
+  platforms: [
+    .macOS(.v10_13),
+    .iOS(.v11),
+  ],
+  products: [
+    .library(name: "Cgit2", targets: ["Cgit2"]),
+  ],
   targets: [
     .target(
       name: "Cgit2",
@@ -12,13 +19,20 @@ let package = Package(
     ),
     .testTarget(name: "Cgit2Tests", dependencies: ["Cgit2"]),
 
-    .binaryTarget(name: "OpenSSL", path: ".build/OpenSSL.xcframework"),
-    .binaryTarget(name: "libgit2", path: ".build/libgit2.xcframework"),
-    .binaryTarget(name: "libssh2", path: ".build/libssh2.xcframework"),
-    // .binaryTarget(
-    //   name: "libgit2",
-    //   url: "https://github.com/sharplet/swift-git/releases/v1.1.0/download/libgit2.xcframework.zip",
-    //   checksum: "ddf955d108d0773effb531457b196f1509573cb2610562c30f9f021cace9edd9"
-    // ),
+    .binaryTarget(
+      name: "OpenSSL",
+      url: "https://github.com/sharplet/swift-cgit2/releases/download/v1.1.0/OpenSSL.xcframework.zip",
+      checksum: "cf95859d15d8f61a229023e70ed3ece532e47a143247de56931c329a029c7d35"
+    ),
+    .binaryTarget(
+      name: "libgit2",
+      url: "https://github.com/sharplet/swift-cgit2/releases/download/v1.1.0/libgit2.xcframework.zip",
+      checksum: "6252d651a74ef953b29d7144ed20cf91be2ebe7f148ea3c0eaba00ddca1cd8cd"
+    ),
+    .binaryTarget(
+      name: "libssh2",
+      url: "https://github.com/sharplet/swift-cgit2/releases/download/v1.1.0/libssh2.xcframework.zip",
+      checksum: "7b34a75674b622cc98c7a524a555817abdea455220070bdfb91b9234f4217c8e"
+    ),
   ]
 )

README.md

@@ -0,0 +1,30 @@
+# swift-cgit2 - libgit2 for Apple platforms
+
+swift-cgit2 is a binary distribution of [libgit2][] for Apple platforms.
+It's provided for the following platforms and architectures:
+
+| Platform | Version    | Architectures     |
+| -------- | ---------- | ----------------- |
+| macOS    | >= 10.13.0 | `x86_64`, `arm64` |
+| iOS      | >= 11.0.0  | `arm64`           |
+
+swift-cgit2 is not intended to provide native Swift bindings to libgit2. For a
+Swift API, take a look at [SwiftGit2][].
+
+[libgit2]: https://libgit2.org
+[SwiftGit2]: https://github.com/SwiftGit2/SwiftGit2
+
+## Versioning
+
+swift-cgit2 will follow the same versioning scheme as libgit2, starting at
+version 1.1.0. If patches are necessary, a new semantic version will be chosen
+that a) doesn't conflict with future libgit2 versions, and b) preserves
+semantic versioning for both libraries (if possible).
+
+Examples of swift-cgit2 patches could include bugs that are found with the
+prebuilt `.xcframework` binaries & build scripts, or the introduction of new
+architectures for existing libgit2 versions.
+
+## License
+
+See [LICENSE](/LICENSE).

bin/upload renamed to bin/archive

@@ -3,7 +3,7 @@
 set -e
 
 print_usage() {
-  echo >&2 "Usage: bin/upload <tag> <xcframework ...>"
+  echo >&2 "Usage: bin/archive <file.xcframework ...>"
 }
 
 truncate() {
@@ -32,7 +32,6 @@ fi
 
 declare -a archives
 manifest=upload-manifest.txt
-tag=$1; shift
 
 truncate "$manifest"
 
@@ -50,5 +49,3 @@ for xcframework; do
 done
 
 echo "Upload manifest written to '$manifest'."
-
-gh release upload "$tag" "${archives[@]}"

bin/build

@@ -5,20 +5,37 @@ set -e
 issh2_dir="$PWD/iSSH2"
 libgit2_dir="$PWD/libgit2"
 
+ios_min_version=11.0.0
+macos_min_version=10.13.0
+
+build_macosx=true
+build_iphoneos=true
+build_iphonesimulator=true
+
+declare -a cmake_configure_opts
+
 build_and_install() {
-  if command -v xcpretty >/dev/null 2>&1; then
-    cmake --build . --target install | xcpretty
-  else
-    cmake --build . --target install
-  fi
+  local platform=$1
+  local build_dir=$2
+  local build_log=$2/build.log
+  echo -n "Building $platform..."
+  trap 'echo " failed. ($build_log)"' ERR
+  cmake --build "$build_dir" --target install >"$build_log"
+  trap - ERR
+  echo " done."
 }
 
 cmake_configure() {
-  cmake -G Xcode "$libgit2_dir" \
+  local build_dir=$1; shift
+  pushd &>/dev/null "$build_dir"
+  cmake "${cmake_configure_opts[@]}" "$libgit2_dir" \
+    -DBUILD_CLAR:BOOL=OFF \
+    -DBUILD_SHARED_LIBS:BOOL=OFF \
+    -DREGEX_BACKEND=builtin \
     -DCMAKE_C_FLAGS=-fembed-bitcode \
-    -DCMAKE_INSTALL_PREFIX="Products/\$ENV{PROJECT_NAME}\$ENV{EFFECTIVE_PLATFORM_NAME}" \
-    -DCMAKE_XCODE_ATTRIBUTE_BITCODE_ENABLED=YES \
+    -DCMAKE_INSTALL_PREFIX="Products" \
     "$@"
+  popd &>/dev/null
 }
 
 cmake_prefix() {
@@ -58,19 +75,25 @@ xcode_arch_sysroots() {
 
 build_openssl() {
   mkdir -p .build/OpenSSL
-  pushd .build/OpenSSL
+  pushd &>/dev/null .build/OpenSSL
 
-  issh2 --no-clean --platform=macosx --archs="arm64 x86_64" --min-version=10.11.0
-  mkdir -p macosx/lib
-  libtool -static -o macosx/lib/libOpenSSL.a "$issh2_dir"/openssl_macosx/lib/*.a
+  if [[ $build_macosx == true ]]; then
+    issh2 --no-clean --platform=macosx --archs="arm64 x86_64" --min-version="$macos_min_version"
+    mkdir -p macosx/lib
+    libtool -static -o macosx/lib/libOpenSSL.a "$issh2_dir"/openssl_macosx/lib/*.a
+  fi
 
-  issh2 --no-clean --platform=iphoneos --archs=arm64 --min-version=9.0.0
-  mkdir -p iphoneos/lib
-  libtool -static -o iphoneos/lib/libOpenSSL.a "$issh2_dir"/openssl_iphoneos/lib/*.a
+  if [[ $build_iphoneos == true ]]; then
+    issh2 --no-clean --platform=iphoneos --archs=arm64 --min-version="$ios_min_version"
+    mkdir -p iphoneos/lib
+    libtool -static -o iphoneos/lib/libOpenSSL.a "$issh2_dir"/openssl_iphoneos/lib/*.a
+  fi
 
-  issh2 --platform=iphonesimulator --archs="arm64 x86_64" --min-version=9.0.0
-  mkdir -p iphonesimulator/lib
-  libtool -static -o iphonesimulator/lib/libOpenSSL.a "$issh2_dir"/openssl_iphonesimulator/lib/*.a
+  if [[ $build_iphonesimulator == true ]]; then
+    issh2 --no-clean --platform=iphonesimulator --archs="arm64 x86_64" --min-version="$ios_min_version"
+    mkdir -p iphonesimulator/lib
+    libtool -static -o iphonesimulator/lib/libOpenSSL.a "$issh2_dir"/openssl_iphonesimulator/lib/*.a
+  fi
 
   rm -rf ../OpenSSL.xcframework
   xcodebuild -create-xcframework \
@@ -82,7 +105,7 @@ build_openssl() {
     -library iphonesimulator/lib/*.a \
     -headers "$issh2_dir"/openssl_iphonesimulator/include
 
-  popd
+  popd &>/dev/null
 
   rm -rf .build/libssh2.xcframework
   xcodebuild -create-xcframework \
@@ -97,91 +120,103 @@ build_openssl() {
 
 # ============================================================================ #
 
-build_libssh2() {
-  mkdir -p .build/libssh2
-  pushd .build/libssh2
-
-  issh2 --platform=macosx --archs="arm64 x86_64" --min-version=10.11.0
-  mkdir -p macosx/lib
-  libtool -static -o macosx/lib/libOpenSSL.a "$issh2_dir"/openssl_macosx/lib/*.a
-
-  issh2 --platform=iphoneos --archs=arm64 --min-version=9.0.0
-  mkdir -p iphoneos/lib
-  libtool -static -o iphoneos/lib/libOpenSSL.a "$issh2_dir"/openssl_iphoneos/lib/*.a
-
-  issh2 --platform=iphonesimulator --archs="arm64 x86_64" --min-version=9.0.0
-  mkdir -p iphonesimulator/lib
-  libtool -static -o iphonesimulator/lib/libOpenSSL.a "$issh2_dir"/openssl_iphonesimulator/lib/*.a
-
-  rm -rf ../OpenSSL.xcframework
-  xcodebuild -create-xcframework \
-    -output ../OpenSSL.xcframework \
-    -library macosx/lib/*.a \
-    -headers "$issh2_dir"/openssl_macosx/include \
-    -library iphoneos/lib/*.a \
-    -headers "$issh2_dir"/openssl_iphoneos/include \
-    -library iphonesimulator/lib/*.a \
-    -headers "$issh2_dir"/openssl_iphonesimulator/include
-
-  popd
-}
-
-# ============================================================================ #
-
 build_libgit2() {
-  mkdir -p .build/libgit2
-  pushd .build/libgit2
-
-  # macosx
-
-  cmake_configure \
-    -DCMAKE_PREFIX_PATH="$(cmake_prefix macosx)" \
-    -DBUILD_SHARED_LIBS:BOOL=OFF \
-    -DBUILD_CLAR:BOOL=OFF \
-    -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" \
-    -DCMAKE_APPLE_ARCH_SYSROOTS="$(xcode_arch_sysroots macosx arm64 x86_64)" \
-    -DCMAKE_OSX_DEPLOYMENT_TARGET=10.13.0 \
-    -DCMAKE_OSX_SYSROOT=macosx
-
-  build_and_install
-
-  # iphoneos
-
-  cmake_configure \
-    -DCMAKE_PREFIX_PATH="$(cmake_prefix iphoneos)" \
-    -DBUILD_SHARED_LIBS:BOOL=OFF \
-    -DBUILD_CLAR:BOOL=OFF \
-    -DREGEX_BACKEND=builtin \
-    -DCMAKE_OSX_ARCHITECTURES=arm64 \
-    -DCMAKE_APPLE_ARCH_SYSROOTS="$(xcode_arch_sysroots iphoneos arm64)" \
-    -DCMAKE_OSX_DEPLOYMENT_TARGET=11.0 \
-    -DCMAKE_OSX_SYSROOT=iphoneos
-
-  build_and_install
-
-  # iphonesimulator
+  if [[ $build_macosx == true ]]; then
+    build_dir=.build/libgit2/macosx
+    configure_log=$build_dir/configure.log
+    mkdir -p "$build_dir"
+
+    echo -n "Configuring macosx..."
+    trap ' failed. ($configure_log)' ERR
+    cmake_configure "$build_dir" \
+      -DCMAKE_PREFIX_PATH="$(cmake_prefix macosx)" \
+      -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" \
+      -DCMAKE_OSX_DEPLOYMENT_TARGET="$macos_min_version" \
+      -DCMAKE_OSX_SYSROOT=macosx \
+      >"$configure_log"
+    trap - ERR
+    echo " done."
+
+    build_and_install macosx "$build_dir"
+  fi
 
-  cmake_configure \
-    -DCMAKE_PREFIX_PATH:PATH="$(cmake_prefix iphonesimulator)" \
-    -DBUILD_SHARED_LIBS:BOOL=OFF \
-    -DBUILD_CLAR:BOOL=OFF \
-    -DREGEX_BACKEND=builtin \
-    -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" \
-    -DCMAKE_APPLE_ARCH_SYSROOTS="$(xcode_arch_sysroots iphonesimulator arm64 x86_64)" \
-    -DCMAKE_OSX_DEPLOYMENT_TARGET=11.0 \
-    -DCMAKE_OSX_SYSROOT=iphonesimulator
+  if [[ $build_iphoneos == true ]]; then
+    build_dir=.build/libgit2/iphoneos
+    configure_log=$build_dir/configure.log
+    mkdir -p "$build_dir"
+
+    echo -n "Configuring iphoneos..."
+    trap ' failed. ($configure_log)' ERR
+    cmake_configure "$build_dir" \
+      -DCMAKE_PREFIX_PATH="$(cmake_prefix iphoneos)" \
+      -DCMAKE_C_COMPILER_WORKS:BOOL=ON \
+      -DCMAKE_OSX_ARCHITECTURES=arm64 \
+      -DCMAKE_OSX_DEPLOYMENT_TARGET="$ios_min_version" \
+      -DCMAKE_OSX_SYSROOT=iphoneos \
+      >"$configure_log"
+    trap - ERR
+    echo " done."
+
+    build_and_install iphoneos "$build_dir"
+  fi
 
-  build_and_install
+  if [[ $build_iphonesimulator == true ]]; then
+    build_dir=.build/libgit2/iphonesimulator
+    configure_log=$build_dir/configure.log
+    mkdir -p "$build_dir"
+
+    echo -n "Configuring iphonesimulator..."
+    trap ' failed. ($configure_log)' ERR
+    cmake_configure "$build_dir" \
+      -DCMAKE_PREFIX_PATH:PATH="$(cmake_prefix iphonesimulator)" \
+      -DCMAKE_OSX_ARCHITECTURES="arm64;x86_64" \
+      -DCMAKE_OSX_DEPLOYMENT_TARGET="$ios_min_version" \
+      -DCMAKE_OSX_SYSROOT=iphonesimulator \
+      >"$configure_log"
+    trap - ERR
+    echo " done."
+
+    build_and_install iphonesimulator "$build_dir"
+  fi
 
   # build xcframework
 
-  create_xcframework ../libgit2.xcframework Products/*
-
-  popd
+  create_xcframework .build/libgit2.xcframework .build/libgit2/*/Products
 }
 
 # ============================================================================ #
 
+for opt; do
+  case $opt in
+    --macosx)
+      build_macosx=true
+      build_iphoneos=false
+      build_iphonesimulator=false
+      ;;
+    --iphoneos)
+      build_macosx=false
+      build_iphoneos=true
+      build_iphonesimulator=false
+      ;;
+    --iphonesimulator)
+      build_macosx=false
+      build_iphoneos=false
+      build_iphonesimulator=true
+      ;;
+    *)
+      echo >&2 "Unknown option '$opt'"
+      exit 1
+      ;;
+  esac
+done
+
 mkdir -p .build
+
 build_openssl
+
+if ninja_path="$(command -v ninja)"; then
+  echo "Configuring CMake to use Ninja (found at path $ninja_path)"
+  cmake_configure_opts+=(-G Ninja)
+fi
+
 build_libgit2