docs cleanup (#91)

motivation: cleanup docs for oss

changes:
* add useful information in readme, with pointers to examples
* update ci setup and example to use latest tools
* update contributors list

Co-authored-by: Yim Lee <[email protected]>

Author: tomerd

CONTRIBUTORS.txt

@@ -16,6 +16,7 @@ needs to be listed here.
 - Johannes Weiss <[email protected]>
 - Norman Maurer <[email protected]>
 - Tomer Doron <[email protected]>
+- tachyonics <[email protected]>
 
 **Updating this list**
 

Examples/LambdaFunctions/Dockerfile

@@ -1,3 +1,3 @@
 FROM swiftlang/swift:nightly-master-amazonlinux2
 
-RUN yum -y install git zip
+RUN yum -y install zip

Examples/LocalDebugging/MyLambda/Dockerfile

@@ -1,3 +1,3 @@
 FROM swiftlang/swift:nightly-master-amazonlinux2
 
-RUN yum -y install git zip
+RUN yum -y install zip

docker/Dockerfile

@@ -1,24 +1,14 @@
-ARG swift_version=5.0
-ARG ubuntu_version=bionic
-ARG base_image=swift:$swift_version-$ubuntu_version
+ARG swift_version=5.2
+# FIXME when 5.2 images are available
+#ARG base_image=swift:$swift_version-amazonlinux2
+ARG base_image=swiftlang/swift:nightly-amazonlinux2
 FROM $base_image
 # needed to do again after FROM due to docker limitation
 ARG swift_version
-ARG ubuntu_version
-
-# set as UTF-8
-RUN apt-get update && apt-get install -y locales locales-all
-ENV LC_ALL en_US.UTF-8
-ENV LANG en_US.UTF-8
-ENV LANGUAGE en_US.UTF-8
 
 # dependencies
-RUN apt-get update && apt-get install -y wget
-RUN apt-get update && apt-get install -y lsof dnsutils netcat-openbsd net-tools curl jq # used by integration tests
-
-# ruby and jazzy for docs generation
-RUN apt-get update && apt-get install -y ruby ruby-dev libsqlite3-dev
-RUN gem install jazzy --no-ri --no-rdoc
+RUN yum install -y wget perl-Digest-SHA
+RUN yum install -y lsof dnsutils netcat-openbsd net-tools curl jq # used by integration tests
 
 # tools
 RUN mkdir -p $HOME/.tools

docker/Dockerfile.ubuntu

@@ -0,0 +1,36 @@
+ARG swift_version=5.0
+ARG ubuntu_version=bionic
+ARG base_image=swift:$swift_version-$ubuntu_version
+FROM $base_image
+# needed to do again after FROM due to docker limitation
+ARG swift_version
+ARG ubuntu_version
+
+# set as UTF-8
+RUN apt-get update && apt-get install -y locales locales-all
+ENV LC_ALL en_US.UTF-8
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US.UTF-8
+
+# dependencies
+RUN apt-get update && apt-get install -y wget
+RUN apt-get update && apt-get install -y lsof dnsutils netcat-openbsd net-tools curl jq # used by integration tests
+
+# ruby and jazzy for docs generation
+RUN apt-get update && apt-get install -y ruby ruby-dev libsqlite3-dev
+RUN gem install jazzy --no-ri --no-rdoc
+
+# tools
+RUN mkdir -p $HOME/.tools
+RUN echo 'export PATH="$HOME/.tools:$PATH"' >> $HOME/.profile
+
+# script to allow mapping framepointers on linux (until part of the toolchain)
+RUN wget -q https://raw.githubusercontent.com/apple/swift/master/utils/symbolicate-linux-fatal -O $HOME/.tools/symbolicate-linux-fatal
+RUN chmod 755 $HOME/.tools/symbolicate-linux-fatal
+
+# swiftformat (until part of the toolchain)
+
+ARG swiftformat_version=0.44.6
+RUN git clone --branch $swiftformat_version --depth 1 https://github.com/nicklockwood/SwiftFormat $HOME/.tools/swift-format
+RUN cd $HOME/.tools/swift-format && swift build -c release
+RUN ln -s $HOME/.tools/swift-format/.build/release/swiftformat $HOME/.tools/swiftformat

docker/docker-compose.1804.52.yaml

@@ -5,6 +5,7 @@ services:
   runtime-setup:
     image: swift-aws-lambda:18.04-5.2
     build:
+      dockerfile: Dockerfile.ubuntu
       args:
         ubuntu_version: "bionic"
         swift_version: "5.2"

docker/docker-compose.1804.53.yaml

@@ -6,7 +6,7 @@ services:
     image: swift-aws-lambda:18.04-5.3
     build:
       args:
-        base_image: "swiftlang/swift:nightly-5.3-bionic"
+        base_image: "swiftlang/swift:nightly-amazonlinux2"
 
   test:
     image: swift-aws-lambda:18.04-5.3