Skip to content

Commit

Permalink
Removed Swift 4.x from CI; updated IBM-Swift org to Kitura; update ja…
Browse files Browse the repository at this point in the history
…zzy docs (#322)

* Removed Swift 4.x from CI; updated IBM-Swift org to Kitura; update jazzy docs

* Add comment on minimum swift version

* Bring back .swift-version file
  • Loading branch information
dannys42 authored Jul 31, 2021
1 parent 1cff7c5 commit 242c986
Show file tree
Hide file tree
Showing 90 changed files with 150 additions and 388 deletions.
40 changes: 13 additions & 27 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,59 +15,45 @@ matrix:
dist: xenial
sudo: required
services: docker
env: DOCKER_IMAGE=swift:4.1.3 SWIFT_SNAPSHOT=4.1.3
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci-ubuntu16.04:5.1.5
- os: linux
dist: xenial
dist: bionic
sudo: required
services: docker
env: DOCKER_IMAGE=swift:4.2.4 SWIFT_SNAPSHOT=4.2.4
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci-ubuntu18.04:5.4
- os: linux
dist: xenial
sudo: required
services: docker
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci:5.0.3 SWIFT_SNAPSHOT=5.0.3
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci-ubuntu18.04:latest USE_SWIFT_DEVELOPMENT_SNAPSHOT=1
- os: linux
dist: xenial
sudo: required
services: docker
# Run Kitura tests in addition to Kitura-net tests
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci:5.1 CUSTOM_TEST_SCRIPT=.kitura-test.sh DOCKER_ENVIRONMENT=CUSTOM_TEST_SCRIPT
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci-ubuntu18.04:latest CUSTOM_TEST_SCRIPT=.kitura-test.sh DOCKER_ENVIRONMENT=CUSTOM_TEST_SCRIPT
- os: linux
dist: xenial
sudo: required
services: docker
# Test GCD_ASYNCH codepath on Linux
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci:5.1 CUSTOM_TEST_SCRIPT=testWithGCD.sh DOCKER_ENVIRONMENT=CUSTOM_TEST_SCRIPT
- os: linux
dist: xenial
sudo: required
services: docker
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci:5.1 SWIFT_SNAPSHOT=$SWIFT_DEVELOPMENT_SNAPSHOT
env: DOCKER_IMAGE=docker.kitura.net/kitura/swift-ci-ubuntu18.04:latest CUSTOM_TEST_SCRIPT=testWithGCD.sh DOCKER_ENVIRONMENT=CUSTOM_TEST_SCRIPT
- os: osx
osx_image: xcode9.4
osx_image: xcode11
sudo: required
env: SWIFT_SNAPSHOT=4.1.2
env: SWIFT_SNAPSHOT=5.1.5 JAZZY_ELIGIBLE=true
- os: osx
osx_image: xcode10.1
osx_image: xcode12.2
sudo: required
env: SWIFT_SNAPSHOT=4.2.1
- os: osx
osx_image: xcode10.2
osx_image: xcode12.5
sudo: required
env: SWIFT_SNAPSHOT=5.0.1 JAZZY_ELIGIBLE=true
env: USE_SWIFT_DEVELOPMENT_SNAPSHOT=1
- os: osx
osx_image: xcode11
osx_image: xcode12.5
sudo: required
# Run Kitura tests in addition to Kitura-net tests
env: CUSTOM_TEST_SCRIPT=.kitura-test.sh
- os: osx
osx_image: xcode12.2
sudo: required
env: SWIFT_SNAPSHOT=5.3.1
- os: osx
osx_image: xcode11
sudo: required
env: SWIFT_SNAPSHOT=$SWIFT_DEVELOPMENT_SNAPSHOT
env: USE_SWIFT_DEVELOPMENT_SNAPSHOT=1 CUSTOM_TEST_SCRIPT=.kitura-test.sh

before_install:
- git clone https://github.com/Kitura/Package-Builder.git
Expand Down
74 changes: 0 additions & 74 deletions Package@swift-4.0.swift

This file was deleted.

74 changes: 0 additions & 74 deletions Package@swift-4.1.swift

This file was deleted.

81 changes: 0 additions & 81 deletions Package@swift-4.2.swift

This file was deleted.

9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</p>

<p align="center">
<a href="https://ibm-swift.github.io/Kitura-net/index.html">
<a href="https://kitura.github.io/Kitura-net/index.html">
<img src="https://img.shields.io/badge/apidoc-KituraNet-1FBCE4.svg?style=flat" alt="APIDoc">
</a>
<a href="https://travis-ci.org/Kitura/Kitura-net">
Expand Down Expand Up @@ -55,6 +55,11 @@ Add `KituraNet` to your target's dependencies:
import KituraNet
```

## Prerequisites

As of Kitura-net 3.0.0, Swift 5.1+ is required.


## Contributing to Kitura-net

All improvements to Kitura-net are very welcome! Here's how to get started with developing Kitura-net itself.
Expand All @@ -70,7 +75,7 @@ All improvements to Kitura-net are very welcome! Here's how to get started with
You can find more info on contributing to Kitura in our [contributing guidelines](https://github.com/Kitura/Kitura/blob/master/.github/CONTRIBUTING.md).

## API Documentation
For more information visit our [API reference](https://ibm-swift.github.io/Kitura-net/index.html).
For more information visit our [API reference](https://kitura.github.io/Kitura-net/index.html).

## Community

Expand Down
4 changes: 2 additions & 2 deletions docs/Classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -885,7 +885,7 @@ <h4>Declaration</h4>
</code></pre>
<h3 id='usage-example' class='heading'>Usage Example:</h3>
<pre class="highlight swift"><code> <span class="kd">func</span> <span class="nf">upgrade</span><span class="p">(</span><span class="nv">handler</span><span class="p">:</span> <span class="kt">IncomingSocketHandler</span><span class="p">,</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">ServerRequest</span><span class="p">,</span> <span class="nv">response</span><span class="p">:</span> <span class="kt">ServerResponse</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">IncomingSocketProcessor</span><span class="p">?,</span> <span class="kt">Data</span><span class="p">?,</span> <span class="kt">String</span><span class="p">?)</span> <span class="p">{</span>
<span class="k">let</span> <span class="p">(</span><span class="nv">processor</span><span class="p">,</span> <span class="nv">responseText</span><span class="p">)</span> <span class="o">=</span> <span class="nf">upgrade</span><span class="p">(</span><span class="nv">handler</span><span class="p">:</span> <span class="n">handler</span><span class="p">,</span> <span class="nv">request</span><span class="p">:</span> <span class="n">request</span><span class="p">,</span> <span class="nv">response</span><span class="p">:</span> <span class="n">response</span><span class="p">)</span>
<span class="nf">let</span> <span class="p">(</span><span class="n">processor</span><span class="p">,</span> <span class="n">responseText</span><span class="p">)</span> <span class="o">=</span> <span class="nf">upgrade</span><span class="p">(</span><span class="nv">handler</span><span class="p">:</span> <span class="n">handler</span><span class="p">,</span> <span class="nv">request</span><span class="p">:</span> <span class="n">request</span><span class="p">,</span> <span class="nv">response</span><span class="p">:</span> <span class="n">response</span><span class="p">)</span>

<span class="k">if</span> <span class="k">let</span> <span class="nv">responseText</span> <span class="o">=</span> <span class="n">responseText</span> <span class="p">{</span>
<span class="nf">return</span> <span class="p">(</span><span class="n">processor</span><span class="p">,</span> <span class="n">responseText</span><span class="o">.</span><span class="nf">data</span><span class="p">(</span><span class="nv">using</span><span class="p">:</span> <span class="o">.</span><span class="n">utf8</span><span class="p">),</span> <span class="s">"text/plain"</span><span class="p">)</span>
Expand Down Expand Up @@ -1042,7 +1042,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura Project Authors</a>. All rights reserved. (Last updated: 2020-11-24)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura Project Authors</a>. All rights reserved. (Last updated: 2021-07-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/BufferList.html
Original file line number Diff line number Diff line change
Expand Up @@ -737,7 +737,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura Project Authors</a>. All rights reserved. (Last updated: 2020-11-24)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura Project Authors</a>. All rights reserved. (Last updated: 2021-07-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/ClientRequest.html
Original file line number Diff line number Diff line change
Expand Up @@ -953,7 +953,7 @@ <h4>Parameters</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura Project Authors</a>. All rights reserved. (Last updated: 2020-11-24)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura Project Authors</a>. All rights reserved. (Last updated: 2021-07-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/Classes/ClientRequest/Options.html
Original file line number Diff line number Diff line change
Expand Up @@ -523,7 +523,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura Project Authors</a>. All rights reserved. (Last updated: 2020-11-24)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura Project Authors</a>. All rights reserved. (Last updated: 2021-07-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/Classes/ClientResponse.html
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ <h3 id='usage-example' class='heading'>Usage Example:</h3>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">@available</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">deprecated</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="s">"This method never worked on Client Responses and was inherited incorrectly from a super class"</span><span class="p">)</span>
<pre class="highlight swift"><code><span class="kd">@available(*, deprecated, message: "This method never worked on Client Responses and was inherited incorrectly from a super class")</span>
<span class="kd">public</span> <span class="k">var</span> <span class="nv">method</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

</div>
Expand Down Expand Up @@ -584,7 +584,7 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura Project Authors</a>. All rights reserved. (Last updated: 2020-11-24)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external">IBM &amp; Kitura Project Authors</a>. All rights reserved. (Last updated: 2021-07-16)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
Expand Down
Loading

0 comments on commit 242c986

Please sign in to comment.