Skip to content

apple/swift-distributed-actors

Repository files navigation

Swift Distributed Actors

The Distributed Systems (and Concurrency) toolkit for Swift.

Development

See CONTRIBUTING.md for a detailed guide on contributing.

See also, STYLE_GUIDE.md for some additional style hints.

Linux

You can use the provided docker images to debug and execute tests inside docker:

docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.1604.51.yaml run shell 
# run all tests docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.1604.51.yaml run test # run only unit tests (no integration tests) docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.1604.51.yaml run unit-tests 

Documentation

Reference documentation

A more "guided" documentation rather than plain API docs is generated using asciidoctor.

./scripts/docs/generate_reference.sh open .build/docs/reference/...-dev/index.html 

API Documentation

API documentation is generated using Jazzy:

./scripts/docs/generate_api.sh open .build/docs/api/...-dev/index.html 

Supported Versions

Swift:

  • Swift 5.2+
  • Swift 5.3 development builds

Operating Systems:

  • Linux systems (Ubuntu and friends)
  • macOS
  • should work but not verified: iOS, iPadOS (get in touch if you need it)

About

Peer-to-peer cluster implementation for Swift Distributed Actors

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors 35

Languages