Merge pull request #12 from QiuZhiFei/dev

feat: add macOS(.V11) platforms declaration to PackageDescription

Author: QiuZhiFei

.github/workflows/jazzy.yml

@@ -8,25 +8,28 @@ on:
 
 jobs:
   Jazzy:
-    runs-on: ubuntu-latest
-    container:
-      image: norionomura/jazzy:latest
+    runs-on: macos-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: ENV
       run: |
         uname -a
         swift --version
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.3
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Build
       run: |
         swift build -v
     - name: Generate documentation json
       run: |
-        sourcekitten doc --spm-module Commands > commands.json
+        brew install sourcekitten
+        sourcekitten doc --spm --module-name Commands > commands.json
     - name: Run jazzy
       run: |
-        jazzy --clean --sourcekitten-sourcefile commands.json
-    - uses: actions/upload-artifact@v2
+        bundle exec jazzy --clean --sourcekitten-sourcefile commands.json
+    - uses: actions/upload-artifact@v4
       with:
         name: API Docs
         path: docs

Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem "jazzy"

Gemfile.lock

@@ -0,0 +1,137 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (3.0.7)
+      base64
+      nkf
+      rexml
+    activesupport (7.1.5)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      mutex_m
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    algoliasearch (1.27.5)
+      httpclient (~> 2.8, >= 2.8.3)
+      json (>= 1.5.1)
+    atomos (0.1.3)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.8)
+    claide (1.1.0)
+    cocoapods (1.16.2)
+      addressable (~> 2.8)
+      claide (>= 1.0.2, < 2.0)
+      cocoapods-core (= 1.16.2)
+      cocoapods-deintegrate (>= 1.0.3, < 2.0)
+      cocoapods-downloader (>= 2.1, < 3.0)
+      cocoapods-plugins (>= 1.0.0, < 2.0)
+      cocoapods-search (>= 1.0.0, < 2.0)
+      cocoapods-trunk (>= 1.6.0, < 2.0)
+      cocoapods-try (>= 1.1.0, < 2.0)
+      colored2 (~> 3.1)
+      escape (~> 0.0.4)
+      fourflusher (>= 2.3.0, < 3.0)
+      gh_inspector (~> 1.0)
+      molinillo (~> 0.8.0)
+      nap (~> 1.0)
+      ruby-macho (>= 2.3.0, < 3.0)
+      xcodeproj (>= 1.27.0, < 2.0)
+    cocoapods-core (1.16.2)
+      activesupport (>= 5.0, < 8)
+      addressable (~> 2.8)
+      algoliasearch (~> 1.0)
+      concurrent-ruby (~> 1.1)
+      fuzzy_match (~> 2.0.4)
+      nap (~> 1.0)
+      netrc (~> 0.11)
+      public_suffix (~> 4.0)
+      typhoeus (~> 1.0)
+    cocoapods-deintegrate (1.0.5)
+    cocoapods-downloader (2.1)
+    cocoapods-plugins (1.0.0)
+      nap
+    cocoapods-search (1.0.1)
+    cocoapods-trunk (1.6.0)
+      nap (>= 0.8, < 2.0)
+      netrc (~> 0.11)
+    cocoapods-try (1.2.0)
+    colored2 (3.1.2)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    drb (2.2.1)
+    escape (0.0.4)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86_64-darwin)
+    fourflusher (2.3.1)
+    fuzzy_match (2.0.4)
+    gh_inspector (1.1.3)
+    httpclient (2.8.3)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    jazzy (0.15.3)
+      cocoapods (~> 1.5)
+      mustache (~> 1.1)
+      open4 (~> 1.3)
+      redcarpet (~> 3.4)
+      rexml (>= 3.2.7, < 4.0)
+      rouge (>= 2.0.6, < 5.0)
+      sassc (~> 2.1)
+      sqlite3 (~> 1.3)
+      xcinvoke (~> 0.3.0)
+    json (2.9.0)
+    liferaft (0.0.6)
+    logger (1.6.2)
+    minitest (5.25.4)
+    molinillo (0.8.0)
+    mustache (1.1.1)
+    mutex_m (0.3.0)
+    nanaimo (0.4.0)
+    nap (1.1.0)
+    netrc (0.11.0)
+    nkf (0.2.0)
+    open4 (1.3.4)
+    public_suffix (4.0.7)
+    redcarpet (3.6.0)
+    rexml (3.3.9)
+    rouge (4.5.1)
+    ruby-macho (2.5.1)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    securerandom (0.3.2)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86_64-darwin)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    xcinvoke (0.3.0)
+      liferaft (~> 0.0.6)
+    xcodeproj (1.27.0)
+      CFPropertyList (>= 2.3.3, < 4.0)
+      atomos (~> 0.1.3)
+      claide (>= 1.0.2, < 2.0)
+      colored2 (~> 3.1)
+      nanaimo (~> 0.4.0)
+      rexml (>= 3.3.6, < 4.0)
+
+PLATFORMS
+  arm64-darwin
+  x86_64-darwin
+
+DEPENDENCIES
+  jazzy
+
+BUNDLED WITH
+   2.5.23

Package.swift

@@ -5,6 +5,9 @@ import PackageDescription
 
 let package = Package(
   name: "swift-commands",
+  platforms: [
+      .macOS(.v11)
+  ],
   products: [
     .library(name: "Commands",
              targets: ["Commands"]),

README_cn.md

@@ -128,7 +128,7 @@ let package = Package(
 )
 ```
 
-## CocoaPods (OS X 10.9+)
+## CocoaPods (OS X 11.0+)
 You can use [CocoaPods](http://cocoapods.org/) to install `Commands` by adding it to your `Podfile`:
 ```ruby
 pod 'Commands',        '~> 0.6.0'