Merge pull request #2 from brightdigit/releases

Releases

.github/workflows/macOS.yml

@@ -6,23 +6,24 @@ jobs:
   build:
     env:
       PACKAGE_NAME: OrchardNest
-      XCODE_PATH: /Applications/Xcode_11.5.app
 
     runs-on: macos-latest
     if: "!contains(github.event.head_commit.message, 'ci skip')"
 
+    strategy:
+      matrix:
+        xcode: ["/Applications/Xcode_11.5.app","/Applications/Xcode_11.6_beta.app","/Applications/Xcode_12_beta.app"]
+
     steps:
     - uses: actions/checkout@v2
     - name: Set Xcode Name
-      run: echo "::set-env name=XCODE_NAME::$(basename -- ${{ env.XCODE_PATH }} | sed 's/\.[^.]*$//' | cut -d'_' -f2)"
+      run: echo "::set-env name=XCODE_NAME::$(basename -- ${{ matrix.xcode }} | sed 's/\.[^.]*$//' | cut -d'_' -f2)"
     - name: Setup Xcode
-      run: sudo xcode-select -s ${{ env.XCODE_PATH }}/Contents/Developer
-    - name: Prepare Build
-      run: brew bundle
+      run: sudo xcode-select -s ${{ matrix.xcode }}/Contents/Developer
     - name: Build
       run: swift build
     - name: Lint
-      run: swiftformat --lint . && swiftlint
+      run: swift run swiftformat --lint . && swift run swiftlint
     - name: Run tests
       run: swift test -v --enable-code-coverage
     - name: Prepare Code Coverage
@@ -32,12 +33,10 @@ jobs:
       env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
     - name: Build Documentation
-      run: sourcedocs generate --spm-module ${{ env.PACKAGE_NAME }}
-    - name: Verify Valid Swift Package
-      run: curl -s https://raw.githubusercontent.com/daveverwer/SwiftPMLibrary/master/script.sh | bash -s -- mine
-    - name: CocoaPods Action
-      run: pod lib lint
+      if: ${{ matrix.xcode == '/Applications/Xcode_12_beta.app' }}
+      run: swift run sourcedocs generate -c --spm-module OrchardNestKit
     - name: Commit files
+      if: ${{ matrix.xcode == '/Applications/Xcode_12_beta.app' }}
       run: |
         git config --local user.email "[email protected]"
         git config --local user.name "GitHub Action"

.github/workflows/ubuntu.yml

@@ -32,8 +32,8 @@ jobs:
       run: swift build
     - name: Run tests
       run: swift test --enable-test-discovery --enable-code-coverage
-    - name: Verify Valid Swift Package
-      run: curl -s https://raw.githubusercontent.com/daveverwer/SwiftPMLibrary/master/script.sh | bash -s -- mine
+    #- name: Verify Valid Swift Package
+    #  run: curl -s https://raw.githubusercontent.com/daveverwer/SwiftPMLibrary/master/script.sh | bash -s -- mine
     - name: Prepare Code Coverage
       run: llvm-cov export -format="lcov" .build/x86_64-unknown-linux-gnu/debug/${{ env.PACKAGE_NAME }}PackageTests.xctest -instr-profile .build/debug/codecov/default.profdata > info.lcov
     - name: Upload to CodeCov.io

.travis.yml

@@ -13,11 +13,11 @@ jobs:
       dist: focal
       arch: arm64
     - os: osx
-      osx_image: xcode11.3
+      osx_image: xcode11.5
     - os: osx
-      osx_image: xcode11.4
+      osx_image: xcode11.6
     - os: osx
-      osx_image: xcode11.5
+      osx_image: xcode12
 env:
   global:
   - FRAMEWORK_NAME=OrchardNest

Documentation/Reference/classes/BlogReader.md

@@ -0,0 +1,20 @@
+**CLASS**
+
+# `BlogReader`
+
+```swift
+public class BlogReader
+```
+
+## Methods
+### `init()`
+
+```swift
+public init()
+```
+
+### `sites(fromURL:)`
+
+```swift
+public func sites(fromURL url: URL) throws -> [LanguageContent]
+```

Documentation/Reference/structs/Channel.md

@@ -0,0 +1,99 @@
+**STRUCT**
+
+# `Channel`
+
+```swift
+public struct Channel: Codable
+```
+
+## Properties
+### `title`
+
+```swift
+public let title: String
+```
+
+### `summary`
+
+```swift
+public let summary: String?
+```
+
+### `author`
+
+```swift
+public let author: String
+```
+
+### `siteUrl`
+
+```swift
+public let siteUrl: URL
+```
+
+### `feedUrl`
+
+```swift
+public let feedUrl: URL
+```
+
+### `twitterHandle`
+
+```swift
+public let twitterHandle: String?
+```
+
+### `image`
+
+```swift
+public let image: URL?
+```
+
+### `updated`
+
+```swift
+public let updated: Date
+```
+
+### `ytId`
+
+```swift
+public let ytId: String?
+```
+
+### `language`
+
+```swift
+public let language: String
+```
+
+### `category`
+
+```swift
+public let category: String
+```
+
+### `items`
+
+```swift
+public let items: [Item]
+```
+
+### `itemCount`
+
+```swift
+public let itemCount: Int?
+```
+
+## Methods
+### `imageURL(fromYoutubeId:)`
+
+```swift
+public static func imageURL(fromYoutubeId ytId: String) -> URL
+```
+
+### `init(language:category:site:)`
+
+```swift
+public init(language: String, category: String, site: Site) throws
+```

Documentation/Reference/structs/Enclosure.md

@@ -0,0 +1,7 @@
+**STRUCT**
+
+# `Enclosure`
+
+```swift
+public struct Enclosure
+```

Documentation/Reference/structs/Item.md

@@ -0,0 +1,68 @@
+**STRUCT**
+
+# `Item`
+
+```swift
+public struct Item: Codable
+```
+
+## Properties
+### `siteUrl`
+
+```swift
+public let siteUrl: URL
+```
+
+### `id`
+
+```swift
+public let id: String
+```
+
+### `title`
+
+```swift
+public let title: String
+```
+
+### `summary`
+
+```swift
+public let summary: String
+```
+
+### `content`
+
+```swift
+public let content: String?
+```
+
+### `url`
+
+```swift
+public let url: URL
+```
+
+### `image`
+
+```swift
+public let image: URL?
+```
+
+### `ytId`
+
+```swift
+public let ytId: String?
+```
+
+### `audio`
+
+```swift
+public let audio: URL?
+```
+
+### `published`
+
+```swift
+public let published: Date
+```

Documentation/Reference/structs/LanguageCategory.md

@@ -0,0 +1,32 @@
+**STRUCT**
+
+# `LanguageCategory`
+
+```swift
+public struct LanguageCategory: Codable
+```
+
+## Properties
+### `title`
+
+```swift
+public let title: String
+```
+
+### `slug`
+
+```swift
+public let slug: String
+```
+
+### `description`
+
+```swift
+public let description: String
+```
+
+### `sites`
+
+```swift
+public let sites: [Site]
+```

Documentation/Reference/structs/LanguageContent.md

@@ -0,0 +1,26 @@
+**STRUCT**
+
+# `LanguageContent`
+
+```swift
+public struct LanguageContent: Codable
+```
+
+## Properties
+### `language`
+
+```swift
+public let language: String
+```
+
+### `title`
+
+```swift
+public let title: String
+```
+
+### `categories`
+
+```swift
+public let categories: [LanguageCategory]
+```

Documentation/Reference/structs/Site.md

@@ -0,0 +1,51 @@
+**STRUCT**
+
+# `Site`
+
+```swift
+public struct Site: Codable
+```
+
+## Properties
+### `title`
+
+```swift
+public let title: String
+```
+
+### `author`
+
+```swift
+public let author: String
+```
+
+### `site_url`
+
+```swift
+public let site_url: URL
+```
+
+### `feed_url`
+
+```swift
+public let feed_url: URL
+```
+
+### `twitter_url`
+
+```swift
+public let twitter_url: URL?
+```
+
+## Methods
+### `init(title:author:site_url:feed_url:twitter_url:)`
+
+```swift
+public init(
+  title: String,
+  author: String,
+  site_url: URL,
+  feed_url: URL,
+  twitter_url: URL?
+)
+```