Skip to content

Commit 2ef446c

Browse files
stephencelismbrandonw
stephencelis
authored and
mbrandonw
committed
🌱
Co-authored-by: Stephen Celis <[email protected]>
0 parents  commit 2ef446c

15 files changed

+1078
-0
lines changed

‎.github/workflows/ci.yml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- '*'
10+
workflow_dispatch:
11+
12+
jobs:
13+
macos_tests:
14+
runs-on: macos-12
15+
strategy:
16+
matrix:
17+
xcode:
18+
- "13.2.1" # Swift 5.5
19+
command:
20+
- test
21+
steps:
22+
- uses: actions/checkout@v2
23+
- name: Select Xcode ${{ matrix.xcode }}
24+
run: sudo xcode-select -s /Applications/Xcode_${{ matrix.xcode }}.app
25+
- name: System
26+
run: system_profiler SPHardwareDataType
27+
- name: Run ${{ matrix.command }}
28+
run: make ${{ matrix.command }}
29+
30+
ubuntu_tests:
31+
strategy:
32+
matrix:
33+
os: [ubuntu-18.04, ubuntu-20.04]
34+
35+
runs-on: ${{ matrix.os }}
36+
37+
steps:
38+
- uses: actions/checkout@v2
39+
- name: Build
40+
run: swift build
41+
- name: Run tests
42+
run: swift test

‎.github/workflows/documentation.yml

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Build and deploy DocC to GitHub pages. Based off of @karwa's work here:
2+
# https://github.com/karwa/swift-url/blob/main/.github/workflows/docs.yml
3+
name: Documentation
4+
5+
on:
6+
release:
7+
types:
8+
- published
9+
push:
10+
branches:
11+
- main
12+
workflow_dispatch:
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout Package
19+
uses: actions/checkout@v2
20+
with:
21+
fetch-depth: 0
22+
23+
- name: Download Swift 5.5.1
24+
run: wget -q https://download.swift.org/swift-5.5.1-release/ubuntu2004/swift-5.5.1-RELEASE/swift-5.5.1-RELEASE-ubuntu20.04.tar.gz
25+
- name: Extract Swift 5.5.1
26+
run: tar xzf swift-5.5.1-RELEASE-ubuntu20.04.tar.gz
27+
- name: Add Swift toolchain to PATH
28+
run: |
29+
echo "$GITHUB_WORKSPACE/swift-5.5.1-RELEASE-ubuntu20.04/usr/bin" >> $GITHUB_PATH
30+
31+
- name: Checkout swift-docc
32+
uses: actions/checkout@v2
33+
with:
34+
repository: apple/swift-docc
35+
ref: main
36+
path: swift-docc
37+
- name: Cache DocC
38+
id: cache-docc
39+
uses: actions/cache@v2
40+
with:
41+
key: swift-url-docc-build
42+
path: swift-docc/.build
43+
- name: Build swift-docc
44+
if: ${{ !steps.cache-docc.outputs.cache-hit }}
45+
run: |
46+
cd swift-docc; swift build --product docc -c release; cd ..
47+
48+
- name: Checkout swift-docc-render
49+
uses: actions/checkout@v2
50+
with:
51+
repository: apple/swift-docc-render
52+
ref: main
53+
path: swift-docc-render
54+
- name: Build swift-docc-render
55+
run: |
56+
cd swift-docc-render; npm install && npm run build; cd ..
57+
58+
- name: Checkout gh-pages Branch
59+
uses: actions/checkout@v2
60+
with:
61+
ref: gh-pages
62+
path: docs-out
63+
64+
- name: Build documentation
65+
run: >
66+
rm -rf docs-out/.git;
67+
rm -rf docs-out/main;
68+
69+
for tag in $(echo "main"; git tag);
70+
do
71+
echo "⏳ Generating documentation for "$tag" release.";
72+
73+
if [ -d "docs-out/$tag" ]
74+
then
75+
echo "✅ Documentation for "$tag" already exists.";
76+
else
77+
git checkout "$tag";
78+
mkdir -p Sources/VaporRouting/Documentation.docc;
79+
export DOCC_HTML_DIR="$(pwd)/swift-docc-render/dist";
80+
81+
rm -rf .build/symbol-graphs;
82+
mkdir -p .build/symbol-graphs;
83+
swift build \
84+
--target VaporRouting \
85+
-Xswiftc \
86+
-emit-symbol-graph \
87+
-Xswiftc \
88+
-emit-symbol-graph-dir \
89+
-Xswiftc \
90+
.build/symbol-graphs \
91+
&& swift-docc/.build/release/docc convert Sources/VaporRouting/Documentation.docc \
92+
--fallback-display-name VaporRouting \
93+
--fallback-bundle-identifier co.pointfree.VaporRouting \
94+
--fallback-bundle-version 0.0.0 \
95+
--additional-symbol-graph-dir \
96+
.build/symbol-graphs \
97+
--transform-for-static-hosting \
98+
--hosting-base-path /swift-vapor-routing/"$tag" \
99+
--output-path docs-out/"$tag" \
100+
&& echo "✅ Documentation generated for "$tag" release." \
101+
|| echo "⚠️ Documentation skipped for "$tag".";
102+
fi;
103+
done
104+
105+
- name: Fix permissions
106+
run: 'sudo chown --recursive $USER docs-out'
107+
- name: Publish documentation to GitHub Pages
108+
uses: JamesIves/[email protected]
109+
with:
110+
branch: gh-pages
111+
folder: docs-out
112+
single-commit: true

‎.github/workflows/format.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Format
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
swift_format:
10+
name: swift-format
11+
runs-on: macOS-11
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: Xcode Select
15+
run: sudo xcode-select -s /Applications/Xcode_13.0.app
16+
- name: Tap
17+
run: brew tap pointfreeco/formulae
18+
- name: Install
19+
run: brew install Formulae/[email protected]
20+
- name: Format
21+
run: make format
22+
- uses: stefanzweifel/git-auto-commit-action@v4
23+
with:
24+
commit_message: Run swift-format
25+
branch: 'main'
26+
env:
27+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.DS_Store
2+
/.build
3+
/Packages
4+
/*.xcodeproj
5+
xcuserdata/
6+
DerivedData/
7+
.swiftpm/config/registries.json
8+
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
9+
.netrc

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Point-Free
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎Makefile

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
PLATFORM_MACOS = macOS
2+
3+
default: test
4+
5+
test:
6+
xcodebuild test \
7+
-scheme vapor-routing \
8+
-destination platform="$(PLATFORM_MACOS)"
9+
10+
test-linux:
11+
docker run \
12+
--rm \
13+
-v "$(PWD):$(PWD)" \
14+
-w "$(PWD)" \
15+
swift:5.3 \
16+
bash -c 'make test-swift'
17+
18+
test-swift:
19+
swift test \
20+
--enable-test-discovery \
21+
--parallel
22+
23+
format:
24+
swift format --in-place --recursive \
25+
./Package.swift ./Sources ./Tests
26+
find . -type f -name '*.md' -print0 | xargs -0 perl -pi -e 's/ +$$//'
27+
28+
.PHONY: format test

0 commit comments

Comments
 (0)