Motivation:
Docs are generated by and hosted on the Swift Package Index. We no
longer need the script to generate docs via Jazzy.
Modifications:
- Remove the generate_docs script
- Remove Jazzy from the Dockerfile but keep Ruby; it's used for
generating test manifests.
- Remove SwiftFormat from the Dockerfile; we don't use it.
Result:
Fewer unused things.
Motivation:
SwiftNIO periodically drops support for older Swift versions. Now that
5.7 has been released, 5.4 will be dropped.
Modifications:
- Remove 5.4 specific Package.swift and docker-compose
- Update the 5.7 docker-compose to use the released 5.7 and move from
focal (2004) to jammy (2204)
- Update docs
Results:
Minimum Swift version is 5.5
Motivation:
Publishing docs is a good thing.
Modifications:
Update Package.swift to allow docc documentation to be generated.
Result:
It is possible to generate docc docs.
As outlined in a [Swift forums post in November ’21](https://forums.swift.org/t/swiftnio-swift-version-support/53232), SwiftNIO will only support the latest non-patch Swift release and the 2 immediately prior non-patch versions.
- drop support for Swift 5.2 and 5.3.
- update CI for Swift 5.4 to run on bionic instead of focal to ensure that we still test bionic.
motivation: fix ci
changes:
* only install ruby and jazzy on focal since jazzy id not supported onlder versions of ubuntu
* fix doc generations script adjusting it to latest source-kittent syntax
Changes made:
Removed CI config for 5.0 ad 5.1
Changed 5.2 to be based on 16.04 so we have some coverage there
Converted Package.swift to the latest syntax
Added a description to supported Swift versions in the README
Motivation:
Ubuntu 16 ruby is too old to support latest cocoapods gem.
Modifications:
Don't install jazzy when on xenial
Result:
Docker image will now build - you need to use bionic images to build documentation.
Motivation:
We were missing the 5.2 & 5.3 docker compose files and also the syntax
wasn't flexible enough to pull in the new nightlies.
Modifications:
- always specify the full image name
- add 5.2 & 5.3
Result:
More CI & newer Swifts.
motivation: publish api docs for helper modules
changes
* add doc publishing script
* add "shell" docker-compose task to help run document publishing from ci
Co-authored-by: Johannes Weiss <johannesweiss@apple.com>
motivation: more secured ci setup
changes:
* enable :z selinux flag on bind mounts so we can enable selinux on ci
* drop potentially exploitable capabilities from docker-compose
Motivation:
We need the docker setup for CI.
Modifications:
Added docker setup. Started with swift-nio's setup and then removed
everything that we don't need (test, http, echo, integration-tests).
Result:
We can move forward doing CI.
