SwiftGit3, as used in App Maker Professional

Swift bindings to libgit2.

This version supports SSH cloning, changing branches, git push/pull, and works well with GitProviders, a SPM which provides a SwiftUI interface for managing git hosting provider credentials.

Because I couldn't figure out how to get libssh2 into the xcframework, you have to add it as a dependency yourself. It is really easy, follow the instructions in the section below.

SwiftGit3 is a fork of SwiftGit2, and tries to follow their lead as close as possible. The name SwiftGit3 is only used in the repository name, so the Swift Package, tests, files, etc. will all use the SwiftGit2 naming.

import SwiftGit2

let URL: URL = ...
let result = Repository.at(URL)
switch result {
case let .success(repo):
    let latestCommit = repo
        .HEAD()
        .flatMap {
            repo.commit($0.oid)
        }

    switch latestCommit {
    case let .success(commit):
        print("Latest Commit: \(commit.message) by \(commit.author.name)")

    case let .failure(error):
        print("Could not get commit: \(error)")
    }

case let .failure(error):
    print("Could not open repository: \(error)")
}

Adding SwiftGit2 to your Project

// swift-tools-version:4.0
import PackageDescription

let package = Package(
    name: "YOUR_PROJECT_NAME",
    dependencies: [
        .package(url: "https://github.com/App-Maker-Software/SwiftGit3.git", from: "1.1.0"),
    ]
)

You also need to add libssh2-ios.a to your project dependecies, or you will get an immediate crash at runtime. I couldn't be bothered to add this dependency into the xcframework. If someone what's the fix this, go ahead and make a PR.

This is how it should look when you add libssh2-ios.a as a dependency in your Xcode build phases.

I don't feel like documenting the rest with pictures, but you also need to add libssl.a and libcrypto.a.

libssh2-ios.a, libssl.a and libcrypto.a should NOT be added to the build phases actually, rather, add this to your other linker flags in your build settings.

-force_load GitProvidersExample/libssl.a -force_load GitProvidersExample/libssh2-ios.a -force_load GitProvidersExample/libcrypto.a (obviously replace GitProvidersExample with your app name, and make sure you path is correct)

And you might need to add libiconv.tbd and libz.tbd to the link with libraries build phase.

SwiftGit3 is a fork of SwiftGit2

The difference is that all major improvments which have been stuck in the PRs at SwiftGit2 are in the main branch here, and new features, such as branch changes, push, pull, SSH cloning, etc, are supported here. Because a real app in production is using SwiftGit3, it's subject to be updated frequently as new feature requests are complete.

There's lot of work needed to be done to clean up some of the new features. PRs are very welcome. While it would be unfortunate for SwiftGit3 to diverge far from SwiftGit2, it's better that problems here get fixed than waiting on activity from SwiftGit2.

Design

SwiftGit3 uses value objects wherever possible. That means using Swift’s structs and enums without holding references to libgit2 objects. This has a number of advantages:

1. Values can be used concurrently.
2. Consuming values won’t result in disk access.
3. Disk access can be contained to a smaller number of APIs.

This vastly simplifies the design of long-lived applications, which are the most common use case with Swift. Consequently, SwiftGit3 APIs don’t necessarily map 1-to-1 with libgit2 APIs.

All methods for reading from or writing to a repository are on SwiftGit’s only class: Repository. This highlights the failability and mutation of these methods, while freeing up all other instances to be immutable structs and enums.

Required Tools

To build SwiftGit2, you'll need the following tools installed locally:

• cmake
• libssh2
• libtool
• autoconf
• automake
• pkg-config

brew install cmake libssh2 libtool autoconf automake pkg-config

Contributions

We ❤️ to receive pull requests! GitHub makes it easy:

1. Fork the repository
2. Create a branch with your changes
3. Send a Pull Request

All contributions should match GitHub’s Swift Style Guide.

License

SwiftGit3 is available under the MIT license.