Swift Packages Repository

Publish Swift packages for your user or organization.

Requirements

To work with the Swift package registry, you need to use swift to consume and a HTTP client (like curl) to publish packages.

Configuring the package registry

To register the package registry and provide credentials, execute:

swift package-registry set https://hoyoship.example.com/api/packages/{owner}/swift
swift package-registry login https://hoyoship.example.com/api/packages/{owner}/swift --username {username} --password {password}

Placeholder	Description
`owner`	The owner of the package.
`username`	Your HoyoShip username.
`password`	Your HoyoShip password. If you are using 2FA or OAuth use a personal access token instead of the password.

The login is optional and only needed if the package registry is private.

Publish a package

First you have to pack the contents of your package:

swift package archive-source

To publish the package perform a HTTP PUT request with the package content in the request body.

curl -X PUT --user {username}:{password} \
   -H "Accept: application/vnd.swift.registry.v1+json" \
   -F source-archive=@/path/to/package.zip \
   -F metadata={metadata} \
   https://hoyoship.example.com/api/packages/{owner}/swift/{scope}/{name}/{version}

Placeholder	Description
`username`	Your HoyoShip username.
`password`	Your HoyoShip password. If you are using 2FA or OAuth use a personal access token instead of the password.
`owner`	The owner of the package.
`scope`	The package scope.
`name`	The package name.
`version`	The package version.
`metadata`	(Optional) The JSON-encoded metadata of the package, see Swift documentation

You cannot publish a package if a package of the same name and version already exists. You must delete the existing package first.

The server responds with the following HTTP Status codes.

HTTP Status Code	Meaning
`201 Created`	The package has been published.
`400 Bad Request`	The package is invalid.
`409 Conflict`	A package file with the same combination of parameters exists already.

Install a package

To install a Swift package from the package registry, add it in the Package.swift file dependencies list:

dependencies: [
  .package(id: "{scope}.{name}", from:"{version}")
]

Parameter	Description
`scope`	The package scope.
`name`	The package name.
`version`	The package version.

Afterwards execute the following command to install it:

swift package resolve