Methods to create a Swift package deal assortment?

What’s a Swift package deal assortment?

A Swift package deal assortment is a curated checklist of packages. Swift Package deal Supervisor customers can subscribe to those collections, this fashion they’re going to have the ability to search libraries and uncover new ones. A group just isn’t equal with a package deal index or registry service, however often means a smaller (one way or the other associated) group of Swift packages.

For instance if you happen to check out the Swift Package deal Index web site, it is all about discovering new Swift packages, however every writer can have its personal assortment, so if we go to the Vapor web page, there you’ll be able to see the URL of the Swift package deal assortment hyperlink. This assortment solely accommodates these packages which are authored by Vapor. It is only a small, curated subset of the complete content material of the Swift Package deal Index web site.

So we are able to say {that a} package deal registry service is concentrated on internet hosting and serving package deal sources, a package deal index service is all about discovering and looking packages and a package deal assortment is often a smaller curated checklist that may be simply shared with others. It may be a listing of your most well-liked Swift dependencies that your organization makes use of for constructing new tasks. 💡

Getting ready the setting

As a way to create a package deal assortment, you will have to put in a software known as Swift package deal assortment generator. It was created by Apple and it was launched on this WWDC session in 2021.

You may set up the package deal assortment generator by working these instructions:

git clone https://github.com/apple/swift-package-collection-generator
cd swift-package-collection-generator 
swift construct --configuration launch

sudo set up .construct/launch/package-collection-generate /usr/native/bin/package-collection-generate
sudo set up .construct/launch/package-collection-diff /usr/native/bin/package-collection-diff
sudo set up .construct/launch/package-collection-sign /usr/native/bin/package-collection-sign
sudo set up .construct/launch/package-collection-validate /usr/native/bin/package-collection-validate

You will additionally want a certificates and a key to be able to signal a package deal assortment. Signing packages aren’t required, however it is suggested. The signature will be added with the package-collection-sign command, however to start with you will want a developer certificates from the Apple developer portal. 🔨

Earlier than you go to the dev portal, merely launch the Keychain Entry app and use the Keychain Entry > Certificates Assitant > Request a Certificates from a Certificates Authority menu merchandise to generate a brand new CertificateSigningRequest.certSigningRequest file. Double verify your e-mail tackle and choose the Saved to disk possibility and press the Proceed button to generate the file.

Now you should utilize the CSR file to generate a brand new certificates utilizing the Apple dev portal. Press the plus icon subsequent to the Certificates textual content and scroll right down to the Providers part, there it is best to see a Swift Package deal Assortment Certificates possibility, choose that one and press the Proceed button. Add your CSR file and press Proceed once more, now it is best to be capable to obtain the certificates that can be utilized to correctly signal your Swift package deal collections. 🖊

We nonetheless must export the personal key that is behind the certificates and we additionally must convert it to the proper format earlier than we are able to begin coping with the contents of the package deal assortment itself. Double click on the downloaded certificates file, this can add it to your keychain. Discover the certificates (click on My Certificates on the highest), proper click on on it and select the Export menu merchandise, save the Certificates.p12 file someplace in your disk. Do not forget so as to add password safety to the exported file, in any other case the important thing extraction will not work.

Now we should always use the openssl to extract the personal key from the p12 file utilizing an RSA format.

openssl pkcs12 -nocerts -in Certificates.p12 -out key.pem && openssl rsa -in key.pem -out rsa_key.pem

Run the command and enter the password that you have used to export the p12 file. This command ought to extract the required key utilizing the right format for the package deal assortment signal command. You will want each the downloaded certificates and the RSA key file in the course of the package deal creation. 📦

Constructing a Swift package deal assortment

It’s time to create a model new Swift package deal assortment. I’ll construct one for my Swift repositories positioned underneath the Binary Birds group. The whole lot begins with a JSON file.

{
    "title": "Binary Birds packages",
    "overview": "This assortment accommodates the our favourite Swift packages.",
    "writer": {
        "title": "Tibor Bödecs"
    },
    "key phrases": [
        "favorite"
    ],
    "packages": [
        {
            "url": "https://github.com/binarybirds/swift-html"
        },
        {
            "url": "https://github.com/BinaryBirds/liquid"
        },
        {
            "url": "https://github.com/BinaryBirds/liquid-kit"
        },
        {
            "url": "https://github.com/BinaryBirds/liquid-local-driver"
        },
        {
            "url": "https://github.com/BinaryBirds/liquid-aws-s3-driver"
        },
        {
            "url": "https://github.com/BinaryBirds/spec"
        }
    ]
}

You may learn extra in regards to the Package deal Assortment format file on GitHub, however if you wish to stick to the fundamentals, it’s just about self-explanatory. You can provide a reputation and a brief overview description to your assortment, set the writer, add some associated key phrases to enhance the search expertise and eventually outline the included packages by way of URLs.

Save this file utilizing the enter.json title. If you happen to run the generate command with this enter file it will attempt to fetch the repositories listed contained in the JSON file. As a way to get extra metadata details about the GitHub repositories it’s also possible to present an -auth-token parameter along with your private entry token, you’ll be able to learn extra in regards to the out there choices by working the command with the -h or --help flag (package-collection-generate -h).

package-collection-generate enter.json ./output.json

The generated output file will include the required package deal assortment metadata, however we nonetheless must signal the output file if we need to correctly use it as a group file. After all the signal step is elective, however it’s advocate to work with signed collections. 😇

package-collection-sign output.json assortment.json rsa_key.pem swift_package.cer

Lastly it is best to add your assortment.json file to a public internet hosting service. For instance I’ve created a easy SPM repository underneath my group and I can use the uncooked file URL of the gathering JSON file to make use of it with SPM or Xcode.

If you happen to desire the command line you could have a number of choices to govern Swift Package deal Collections. For more information you’ll be able to learn the associated Swift Package deal Supervisor documentation, however listed below are some instance instructions that you should utilize so as to add, checklist, refresh search or take away a group:

swift package-collection checklist
swift package-collection add https://uncooked.githubusercontent.com/BinaryBirds/SPM/most important/assortment.json
swift package-collection refresh
swift package-collection search --keywords html

swift package-collection take away https://uncooked.githubusercontent.com/BinaryBirds/SPM/most important/assortment.json

If you’re growing apps utilizing Xcode, you should utilize the Package deal Dependencies menu underneath your mission settings to handle your package deal dependencies and use package deal collections.

Swift Package deal Collections are nice if you wish to set up your Swift libraries and also you need to share them with others. If you’re a heavy Xcode consumer you will get pleasure from utilizing collections for certain. ☺️