Registry

BETA

This feature is currently in beta. If you encounter any issues, please report them at our community forum.

REMOTE PROJECT REQUIRED

This feature requires a remote project.

As the number of dependencies grows, so does the time to resolve them. While other package managers like CocoaPods or npm are centralized, Swift Package Manager is not. Because of that, SwiftPM needs to resolve dependencies by doing a deep clone of each repository, which can be time-consuming. To address this, Tuist provides an implementation of the Package Registry, so you can download only the commit you actually need. The packages in the registry are based on the Swift Package Index – if you can find a package there, the package is also available in the Tuist Registry. Additionally, the packages are distributed across the globe using an edge storage for minimum latency when resolving them.

Usage

To set up and login to the registry, cd into your project's directory and run:

tuist registry setup # Creates a `registries.json` file with the default registry configuration.
tuist registry login # Logs you into the registry.

Now you can access the registry! To resolve dependencies from the registry instead of from source control, follow the section below based on your setup.

Xcode projects

Support for Xcode projects is coming soon.

Follow the latest development at our community forum.

Tuist project with the Xcode default integration

Support for Tuist projects with the Xcode default integration of packages is coming soon.

Follow the latest development at our community forum.

Tuist project with the XcodeProj-based integration

If you are using the XcodeProj-based integration, you can use the --replace-scm-with-registry flag to resolve dependencies from the registry if they are available. Add it to the installOptions in your Tuist.swift file:

import ProjectDescription

let tuist = Tuist(
    fullHandle: "{account-handle}/{project-handle}",
    project: .tuist(
        installOptions: .options(passthroughSwiftPackageManagerArguments: ["--replace-scm-with-registry"])
    )
)

If you want to ensure that the registry is used every time you resolve dependencies, you will need to update dependencies in your Tuist/Package.swift file to use the registry identifier instead of a URL. The registry identifier is always in the form of {organization}.{repository}. For example, to use the registry for the swift-composable-architecture package, do the following:

dependencies: [
-   .package(url: "https://github.com/pointfreeco/swift-composable-architecture", from: "0.1.0")
+   .package(id: "pointfreeco.swift-composable-architecture", from: "0.1.0")
]

Swift package

If you are working on a Swift package, you can use the --replace-scm-with-registry flag to resolve dependencies from the registry if they are available:

swift package --replace-scm-with-registry resolve

If you want to ensure that the registry is used every time you resolve dependencies, you will need to update dependencies in your Package.swift file to use the registry identifier instead of a URL. The registry identifier is always in the form of {organization}.{repository}. For example, to use the registry for the swift-composable-architecture package, do the following:

dependencies: [
-   .package(url: "https://github.com/pointfreeco/swift-composable-architecture", from: "0.1.0")
+   .package(id: "pointfreeco.swift-composable-architecture", from: "0.1.0")
]

Continuous Integration (CI)

To use the registry on your CI, you need to ensure that you have logged in to the registry by running tuist registry login as part of your workflow.

Since the registry credentials are stored in a keychain, you need to set it up as well. Note some CI providers or automation tools like Fastlane already create a temporary keychain or provide a built-in way how to create one. However, you can also create one by creating a custom step with the following code:

TMP_DIRECTORY=$(mktemp -d)
KEYCHAIN_PATH=$TMP_DIRECTORY/keychain.keychain
KEYCHAIN_PASSWORD=$(uuidgen)
security create-keychain -p $KEYCHAIN_PASSWORD $KEYCHAIN_PATH
security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
security default-keychain -s $KEYCHAIN_PATH
security unlock-keychain -p $KEYCHAIN_PASSWORD $KEYCHAIN_PATH

An example workflow for GitHub Actions could then look like this:

name: Build

jobs:
  build:
    steps:
      - # Your set up steps...
      - run: tuist registry login
      - run: |
        TMP_DIRECTORY=$(mktemp -d)
        KEYCHAIN_PATH=$TMP_DIRECTORY/keychain.keychain
        KEYCHAIN_PASSWORD=$(uuidgen)
        security create-keychain -p $KEYCHAIN_PASSWORD $KEYCHAIN_PATH
        security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
        security default-keychain -s $KEYCHAIN_PATH
        security unlock-keychain -p $KEYCHAIN_PASSWORD $KEYCHAIN_PATH
      - run: tuist build