Merge pull request #40 from cybozu/documentation

Documentation Base
cybozu · Jul 7, 2024 · 4da651c · 4da651c
2 parents 69cbe56 + 7ca1540
commit 4da651c
Show file tree

Hide file tree

Showing 18 changed files with 75 additions and 105 deletions.
diff --git a/.github/workflows/deploy_docc.yml b/.github/workflows/deploy_docc.yml
@@ -0,0 +1,54 @@
+name: Deploy DocC
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - README.md
+      - .gitignore
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: macos-14
+    env:
+      DEVELOPER_DIR: /Applications/Xcode_15.4.app/Contents/Developer
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build DocC
+        run: |
+          swift package --allow-writing-to-directory ./docs \
+            generate-documentation \
+            --target LicenseList \
+            --disable-indexing \
+            --transform-for-static-hosting \
+            --hosting-base-path LicenseList \
+            --output-path ./docs
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: "https://cybozu.github.io/LicenseList/documentation/licenselist/"
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/Examples/Examples.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/Examples/Examples.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
@@ -35,6 +35,24 @@
         "revision" : "ee97538f5b81ae89698fd95938896dec5217b148",
         "version" : "1.1.1"
       }
+    },
+    {
+      "identity" : "swift-docc-plugin",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-plugin.git",
+      "state" : {
+        "revision" : "26ac5758409154cc448d7ab82389c520fa8a8247",
+        "version" : "1.3.0"
+      }
+    },
+    {
+      "identity" : "swift-docc-symbolkit",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/apple/swift-docc-symbolkit",
+      "state" : {
+        "revision" : "b45d1f2ed151d057b54504d653e0da5552844e34",
+        "version" : "1.0.0"
+      }
     }
   ],
   "version" : 2

diff --git a/Package.swift b/Package.swift
@@ -13,6 +13,9 @@ let package = Package(
             targets: ["LicenseList"]
         )
     ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-docc-plugin.git", exact: "1.3.0")
+    ],
     targets: [
         .executableTarget(
             name: "spp",

diff --git a/Plugins/PrepareLicenseList/main.swift b/Plugins/PrepareLicenseList/main.swift
@@ -1,10 +1,3 @@
-//
-//  main.swift
-//
-//
-//  Created by ky0me22 on 2022/09/29.
-//
-
 import Foundation
 import PackagePlugin
 

diff --git a/Sources/LicenseList/Library.swift b/Sources/LicenseList/Library.swift
@@ -1,10 +1,3 @@
-//
-//  Library.swift
-//
-//
-//  Created by ky0me22 on 2022/06/03.
-//
-
 import Foundation
 
 public struct Library: Identifiable, Hashable {

diff --git a/Sources/LicenseList/LicenseListView.swift b/Sources/LicenseList/LicenseListView.swift
@@ -1,10 +1,3 @@
-//
-//  LicenseListView.swift
-//
-//
-//  Created by ky0me22 on 2022/06/03.
-//
-
 import SwiftUI
 
 public struct LicenseListView: View {

diff --git a/Sources/LicenseList/LicenseListViewController.swift b/Sources/LicenseList/LicenseListViewController.swift
@@ -1,10 +1,3 @@
-//
-//  LicenseListViewController.swift
-//  
-//
-//  Created by ky0me22 on 2022/06/06.
-//
-
 import UIKit
 import SwiftUI
 

diff --git a/Sources/LicenseList/LicenseListViewStyle.swift b/Sources/LicenseList/LicenseListViewStyle.swift
@@ -1,10 +1,3 @@
-//
-//  LicenseListViewStyle.swift
-//
-//
-//  Created by 宮本大新 on 2023/11/16.
-//
-
 import SwiftUI
 
 public enum LicenseListViewStyle {

diff --git a/Sources/LicenseList/LicenseView.swift b/Sources/LicenseList/LicenseView.swift
@@ -1,10 +1,3 @@
-//
-//  LicenseView.swift
-//
-//
-//  Created by ky0me22 on 2022/06/03.
-//
-
 import SwiftUI
 
 public struct LicenseView: View {

diff --git a/Sources/LicenseList/String+Extensions.swift b/Sources/LicenseList/String+Extensions.swift
@@ -1,10 +1,3 @@
-//
-//  String+Extensions.swift
-//  
-//
-//  Created by ky0me22 on 2022/06/03.
-//
-
 import Foundation
 
 extension StringProtocol {

diff --git a/Sources/LicenseList/URL+Extension.swift b/Sources/LicenseList/URL+Extension.swift
@@ -1,10 +1,3 @@
-//
-//  URL+Extension.swift
-//  
-//
-//  Created by ky0me22 on 2023/09/26.
-//
-
 import Foundation
 
 extension URL {

diff --git a/Sources/LicenseList/View+Extensions.swift b/Sources/LicenseList/View+Extensions.swift
@@ -1,10 +1,3 @@
-//
-//  View+Extensions.swift
-//  
-//
-//  Created by ky0me22 on 2022/06/06.
-//
-
 import SwiftUI
 
 extension View {

diff --git a/Sources/SourcePackagesParser/Library.swift b/Sources/SourcePackagesParser/Library.swift
@@ -1,10 +1,3 @@
-//
-//  Library.swift
-//  
-//
-//  Created by ky0me22 on 2022/06/03.
-//
-
 import Foundation
 
 struct Library: Hashable {

diff --git a/Sources/SourcePackagesParser/SPPError.swift b/Sources/SourcePackagesParser/SPPError.swift
@@ -1,10 +1,3 @@
-//
-//  SPPError.swift
-//  
-//
-//  Created by ky0me22 on 2022/06/03.
-//
-
 enum SPPError: Error {
     case couldNotReadFile(String)
     case couldNotExportLicenseList

diff --git a/Sources/SourcePackagesParser/SourcePackagesParser.swift b/Sources/SourcePackagesParser/SourcePackagesParser.swift
@@ -1,10 +1,3 @@
-//
-//  SourcePackagesParser.swift
-//  
-//
-//  Created by ky0me22 on 2022/06/03.
-//
-
 import Foundation
 
 final class SourcePackagesParser {

diff --git a/Sources/SourcePackagesParser/String+Extension.swift b/Sources/SourcePackagesParser/String+Extension.swift
@@ -1,10 +1,3 @@
-//
-//  String+Extension.swift
-//  
-//
-//  Created by ky0me22 on 2022/06/03.
-//
-
 import Foundation
 
 extension String {

diff --git a/Sources/SourcePackagesParser/WorkspaceState.swift b/Sources/SourcePackagesParser/WorkspaceState.swift
@@ -1,10 +1,3 @@
-//
-//  WorkspaceState.swift
-//  
-//
-//  Created by ky0me22 on 2022/06/03.
-//
-
 import Foundation
 
 struct WorkspaceState: Decodable {

diff --git a/Sources/SourcePackagesParser/main.swift b/Sources/SourcePackagesParser/main.swift
@@ -1,10 +1,3 @@
-//
-//  main.swift
-//
-//
-//  Created by ky0me22 on 2022/06/03.
-//
-
 import Foundation
 
 func exitWithUsage() -> Never {