Skip to content

Commit 73610b8

Browse files
pauljohanneskraftpauljohanneskraft
committed
Replace jazzy documentation with DocC
1 parent d4297b2 commit 73610b8

600 files changed

Lines changed: 998 additions & 1924 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/ci.yml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [master, main, "feature/**", "release/**"]
6+
pull_request:
7+
branches: [master, main]
8+
9+
concurrency:
10+
group: ci-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
build-test:
15+
name: Build & Test (iOS Simulator)
16+
runs-on: macos-14
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- name: Select Xcode
21+
run: sudo xcode-select -s /Applications/Xcode_15.4.app
22+
23+
- name: Show toolchain
24+
run: |
25+
xcodebuild -version
26+
swift --version
27+
28+
- name: Resolve packages
29+
run: swift package resolve
30+
31+
- name: Build (iOS Simulator)
32+
run: |
33+
xcodebuild build \
34+
-scheme XCoordinator \
35+
-destination 'generic/platform=iOS Simulator' \
36+
-skipPackagePluginValidation \
37+
CODE_SIGNING_ALLOWED=NO
38+
39+
- name: Test
40+
run: |
41+
xcodebuild test \
42+
-scheme XCoordinator \
43+
-destination 'platform=iOS Simulator,name=iPhone 15' \
44+
-skipPackagePluginValidation \
45+
CODE_SIGNING_ALLOWED=NO
46+
47+
pod-lint:
48+
name: CocoaPods lint
49+
runs-on: macos-14
50+
steps:
51+
- uses: actions/checkout@v4
52+
53+
- name: Select Xcode
54+
run: sudo xcode-select -s /Applications/Xcode_15.4.app
55+
56+
- name: Lint podspec
57+
run: pod lib lint --allow-warnings --fail-fast
58+
59+
docs:
60+
name: DocC build
61+
runs-on: macos-14
62+
steps:
63+
- uses: actions/checkout@v4
64+
65+
- name: Select Xcode
66+
run: sudo xcode-select -s /Applications/Xcode_15.4.app
67+
68+
- name: Build documentation
69+
run: |
70+
swift package \
71+
--allow-writing-to-directory ./Documentation \
72+
generate-documentation \
73+
--target XCoordinator \
74+
--output-path ./Documentation \
75+
--transform-for-static-hosting \
76+
--warnings-as-errors

‎.github/workflows/docs.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Publish documentation
2+
3+
on:
4+
push:
5+
tags: ["*"]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: macos-14
20+
steps:
21+
- uses: actions/checkout@v4
22+
23+
- name: Select Xcode
24+
run: sudo xcode-select -s /Applications/Xcode_15.4.app
25+
26+
- name: Build documentation
27+
run: |
28+
swift package \
29+
--allow-writing-to-directory ./Documentation \
30+
generate-documentation \
31+
--target XCoordinator \
32+
--output-path ./Documentation \
33+
--transform-for-static-hosting \
34+
--hosting-base-path XCoordinator \
35+
--warnings-as-errors
36+
37+
- name: Upload artifact
38+
uses: actions/upload-pages-artifact@v3
39+
with:
40+
path: ./Documentation
41+
42+
deploy:
43+
needs: build
44+
runs-on: ubuntu-latest
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Mac OS X
2-
*.DS_Store
1+
# macOS
2+
**/.DS_Store
33

44
# Xcode
5-
.build
5+
.build/
66
*.pbxuser
77
*.mode1v3
88
*.mode2v3
@@ -12,17 +12,21 @@ project.xcworkspace/
1212
xcuserdata/
1313
Pods/*.xcodeproj/xcuserdata/
1414

15+
# Swift Package Manager
16+
/.swiftpm/xcode/xcuserdata/
17+
/.swiftpm/xcode/package.xcworkspace/xcuserdata/
18+
/.swiftpm/configuration/
19+
Package.resolved
20+
1521
# Generated files
1622
*.o
1723
*.pyc
1824

19-
# Docs
20-
docs/docsets/XCoordinator.tgz
21-
docs/undocumented.json
25+
# Documentation outputs
26+
/Documentation/
27+
*.doccarchive/
2228

2329
# Backup files
2430
*~.nib
2531
\#*#
2632
.#*
27-
28-
.swiftpm

‎.jazzy.yaml‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.travis.yml‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎Package.resolved‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎Package.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
// swift-tools-version:5.8
1+
// swift-tools-version:5.9
22

33
import PackageDescription
44

55
let package = Package(
66
name: "XCoordinator",
7-
platforms: [.iOS(.v11), .tvOS(.v11)],
7+
platforms: [.iOS(.v14), .tvOS(.v14)],
88
products: [
99
.library(
1010
name: "XCoordinator",
@@ -14,8 +14,8 @@ let package = Package(
1414
targets: ["XCoordinatorRx"]),
1515
],
1616
dependencies: [
17-
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
18-
.package(url: "https://github.com/ReactiveX/RxSwift.git", from: "6.0.0"),
17+
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
18+
.package(url: "https://github.com/ReactiveX/RxSwift.git", from: "6.5.0"),
1919
],
2020
targets: [
2121
.target(

0 commit comments

Comments
 (0)