Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 1.82 KB

README.md

File metadata and controls

67 lines (47 loc) · 1.82 KB
Raw

Swift Package Registry - Reference Implementation

This is a reference implementation for a package registry service, as described in this proposal.

Requirements

  • macOS 10.14+
  • Swift 5.2+ (install the latest version of Xcode)
  • Homebrew
  • Docker* (optional)

Setup

Install the required system dependencies by running the following command:

$ brew bundle

Usage

A command-line interface is provided in addition to the web server for more convenient testing and debugging.

Server

Run the following command to spin up a package registry locally.

$ swift run registry serve --index path/to/index

A registry index (that is, a Git repository used as a database) will be created at the specified path if one doesn't already exist there.

You can interact with the registry using curl or your REST client of choice.

$ curl -H "Accept: application/vnd.swift.registry.v1+json" \
       "http://localhost:8080/@Alamofire/Alamofire"

Command Line Interface

$ swift run registry --help
USAGE: registry-command <subcommand>

OPTIONS:
  --version               Show the version.
  -h, --help              Show help information.

SUBCOMMANDS:
  init                    Initializes a new registry at the specified path.
  publish                 Creates a new release of a package.
  serve                   Runs the registry web service locally.

  See 'registry-command help <subcommand>' for detailed help.

$ swift run registry init --index path/to/index
$ swift run registry publish @Jounce/Surge 2.3.0 --index path/to/index
$ swift run registry publish @Flight-School/Money 1.2.0 --index path/to/index
$ swift run registry list --index path/to/index
@flight-school/Money - 1.2.0
@jounce/Surge - 2.3.0