Change default branch to main (#9)

* change ci/cd branch to main * Modify README * remove linux support on test * remove Trailing spaces * fix syntax error in workflow * upgrade fwal/[email protected] version * use SwiftEnv * work with workflow * work with workflow * sync * remove xcode version * remove xcode version * remove duplicate swift version
sboh1214 · Oct 6, 2020 · b901d5e · b901d5e
1 parent 00dd970
commit b901d5e
Show file tree

Hide file tree

Showing 12 changed files with 76 additions and 67 deletions.
diff --git a/.github/workflows/Coverage.yml b/.github/workflows/Coverage.yml
@@ -3,7 +3,7 @@ name: Coverage
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   coverage:
@@ -20,6 +20,5 @@ jobs:
       run: xcrun llvm-cov export -format="lcov" .build/debug/HwpKitPackageTests.xctest/Contents/MacOS/HwpKitPackageTests -instr-profile .build/debug/codecov/default.profdata > info.lcov
     - name: Upload to Codecov
       run: bash <(curl https://codecov.io/bash)
-      env: 
+      env:
         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
@@ -3,7 +3,7 @@ name: Documentation
 on:
   push:
     branches:
-    - master
+    - main
 
 jobs:
   documentation:

diff --git a/.github/workflows/Lint.yml b/.github/workflows/Lint.yml
@@ -1,6 +1,12 @@
 name: Lint
 
-on: [ push, pull_request ]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   lint:

diff --git a/.github/workflows/Test.yml b/.github/workflows/Test.yml
@@ -1,22 +1,29 @@
 name: Test
 
-on: [ push, pull_request ]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   test:
-    name: Test on ${{ matrix.os }} and swift ${{ matrix.swift }}
-    runs-on: ${{ matrix.os }}
+    name: Test on Xcode ${{ matrix.xcode }}
+    runs-on: macos-latest
     strategy:
       matrix:
-        os: [macOS-latest]
-        swift: ["5.1", "5.2"]
+        xcode: ["11.7", "11.3.1"]
 
     steps:
     - uses: actions/checkout@v2
-    - name: Setup Swift
-      uses: fwal/[email protected]
-      with:
-        swift-version: ${{ matrix.swift }}
+    - name: Set Xcode version
+      run: |
+        sudo xcode-select -s /Applications/Xcode_${{ matrix.xcode }}.app/
+        export TOOLCHAINS=swift
+    - name: Get Swift version
+      run:  swift --version
     - name: Build
       run: swift build -v
     - name: Run tests

diff --git a/README.md b/README.md
@@ -6,17 +6,47 @@
 ![Coverage](https://github.com/sboh1214/HwpKit/workflows/Coverage/badge.svg)
 ![Documentation](https://github.com/sboh1214/HwpKit/workflows/Documentation/badge.svg)
 ![Lint](https://github.com/sboh1214/HwpKit/workflows/Lint/badge.svg)
-[![codecov](https://codecov.io/gh/sboh1214/HwpKit/branch/master/graph/badge.svg)](https://codecov.io/gh/sboh1214/HwpKit)
-
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=sboh1214_HwpKit&metric=alert_status)](https://sonarcloud.io/dashboard?id=sboh1214_HwpKit)
-[![CodeFactor](https://www.codefactor.io/repository/github/sboh1214/hwpkit/badge)](https://www.codefactor.io/repository/github/sboh1214/hwpkit)
 
 Swift Package for Reading & Writing HWP File
 
 ## Install
 
 ### Swift Package Manager
 
+Go to ```File``` > ```Swift Packages``` > ```Add Package Dependency...``` in Xcode.
+
+Or add dependency manually.
+```swift
+dependencies: [
+    .package(url: "https://github.com/sboh1214/HwpKit.git", .branch("main")),
+],
+```
+
+## Contribute
+
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=sboh1214_HwpKit&metric=ncloc)](https://sonarcloud.io/dashboard?id=sboh1214_HwpKit)
+
+### Code Quality
+
+[![codecov](https://codecov.io/gh/sboh1214/HwpKit/branch/master/graph/badge.svg)](https://codecov.io/gh/sboh1214/HwpKit)
+[![CodeFactor](https://www.codefactor.io/repository/github/sboh1214/hwpkit/badge)](https://www.codefactor.io/repository/github/sboh1214/hwpkit)
+
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=sboh1214_HwpKit&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=sboh1214_HwpKit)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=sboh1214_HwpKit&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=sboh1214_HwpKit)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=sboh1214_HwpKit&metric=security_rating)](https://sonarcloud.io/dashboard?id=sboh1214_HwpKit)
+
+
+
+### Test on Linux
+
+Currently, this project does not support Linux due to dependency [DataCompression](https://github.com/mw99/DataCompression).
+You should install [Sourcery](https://github.com/krzysztofzablocki/Sourcery) to create LinuxMain.swift and test.
+
+```bash
+$ sourcery --sources Tests --templates Tests/LinuxMain.stencil
+$ swift test
+```
+
 ## License
 
 ![GitHub](https://img.shields.io/github/license/sboh1214/HwpKit)
diff --git a/Tests/HwpKitTests/Blank/BlankTests.swift b/Tests/HwpKitTests/Blank/BlankTests.swift
@@ -31,11 +31,4 @@ final class BlankTests: XCTestCase {
         let hwp = try openHwp()
         XCTAssertEqual(hwp.fileHeader.encryptVersion, 4)
     }
-
-    static var allTests = [
-        ("testOpen", testOpen),
-        ("testSignature", testSignature),
-        ("testHwpVersion", testHwpVersion),
-        ("testEncryptVersion", testEncryptVersion)
-    ]
 }
diff --git a/Tests/HwpKitTests/HwpUtilTests.swift b/Tests/HwpKitTests/HwpUtilTests.swift
@@ -7,8 +7,4 @@ final class HwpUtilTests: XCTestCase {
         let bits = [false, true, false, false, true, false, true, false].reversed() as [Bool]
         XCTAssertEqual(bits, byte.bits)
     }
-
-    static var allTests = [
-        ("testBitsFromInt8", testBitsFromInt8)
-    ]
 }
diff --git a/Tests/HwpKitTests/Noori/NooriDocInfoTests.swift b/Tests/HwpKitTests/Noori/NooriDocInfoTests.swift
@@ -93,16 +93,4 @@ final class NooriDocInfoTests: XCTestCase {
         let hwp = try openHwp()
         XCTAssertEqual(hwp.sectionArray[0].paragraph[2].ctrlHeaderArray![0].ctrlId, 1885826672)
     }
-
-    static var allTests = [
-        ("testSectionSize", testSectionSize),
-        ("testStartingIndex", testStartingIndex),
-        ("testCaratLocation", testCaratLocation),
-        ("testBinData", testBinData),
-        ("testFaceName", testFaceName),
-        ("testBorderFill", testBorderFill),
-        ("testCharShape", testCharShape),
-        ("testTabDef", testTabDef),
-        ("testCtrlHeader", testCtrlHeader)
-    ]
 }
diff --git a/Tests/HwpKitTests/Noori/NooriSectionTests.swift b/Tests/HwpKitTests/Noori/NooriSectionTests.swift
@@ -53,11 +53,4 @@ final class NooriSectionTests: XCTestCase {
 
         XCTAssertNotNil(hwp.sectionArray[0].paragraph[20].paraLineSegArray![0])
     }
-
-    static var allTests = [
-        ("testParagraph", testParagraph),
-        ("testParaText", testParaText),
-        ("testParaCharShape", testParaCharShape),
-        ("testParaLineSeg", testParaLineSeg)
-    ]
 }
diff --git a/Tests/HwpKitTests/XCTestManifests.swift b/Tests/HwpKitTests/XCTestManifests.swift
diff --git a/Tests/LinuxMain.stencil b/Tests/LinuxMain.stencil
@@ -0,0 +1,16 @@
+import XCTest
+import HwpKitTests
+
+{% for type in types.classes|based:"XCTestCase" %}
+{% if not type.annotations.disableTests %}extension {{ type.name }} {
+  static var allTests: [(String, ({{ type.name }}) -> () throws -> Void)] = [
+  {% for method in type.methods %}{% if method.parameters.count == 0 and method.shortName|hasPrefix:"test" %}  ("{{ method.shortName }}", {{ method.shortName }}){{ ',' if not forloop.last }}
+  {% endif %}{% endfor %}]
+}
+{% endif %}{% endfor %}
+
+// swiftlint:disable trailing_comma
+XCTMain([
+{% for type in types.classes|based:"XCTestCase" %}{% if not type.annotations.disableTests %}  testCase({{ type.name }}.allTests),
+{% endif %}{% endfor %}])
+// swiftlint:enable trailing_comma
diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,7 @@ name: Documentation @@
     on:
       push:
         branches:
-        - master
+        - main
     jobs:
       documentation:
@@ Expand Down @@