Integrate Swiftlint and Danger in CircleCI

Vkt0r · Vkt0r · commit 20945277323d · 2019-04-19T23:44:32.000-04:00
* Add jobs to run Swiftlint and Danger as part of the CI
* Add the `Dangerfile` with some basics rules for the project
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,6 +1,22 @@
 version: 2
 
 jobs:
+  swiftlint:
+    docker:
+      - image: dantoml/swiftlint:latest
+    steps:
+      - checkout
+      - run: swiftlint lint --reporter junit | tee result.xml
+      - store_artifacts:
+          path: result.xml
+      - store_test_results:
+          path: result.xml
+  danger:
+    docker:
+      - image: dantoml/danger:latest
+    steps:
+      - checkout
+      - run: danger
   macos:
     environment:
       TEST_REPORTS: /tmp/test-results
@@ -51,5 +67,7 @@ workflows:
   version: 2
   tests:
     jobs:
+      - swiftlint
+      - danger
       - linux
       - macos
diff --git a/Dangerfile b/Dangerfile
@@ -0,0 +1,37 @@
+# send a welcome message for the user
+message "Welcome, @#{github.pr_author}."
+
+# Just to let people know
+warn("PR is classed as Work in Progress.") if github.pr_title.include? "[WIP]"
+
+# ensure that the PR have an assignee
+warn "This PR does not have any assignees yet." unless github.pr_json["assignee"]
+
+# Warn when there is a big PR
+warn("Big PR") if git.lines_of_code > 500
+
+# ensure there is a summary for a PR
+fail "Please provide a summary in the Pull Request description." if github.pr_body.length < 5
+
+# Changelog entries are required for changes to library files.
+fail("Please include a CHANGELOG entry. \nYou can find it at [CHANGELOG.md](https://github.com/httpswift/swifter/blob/stable/CHANGELOG.md).") unless git.modified_files.include?("CHANGELOG.md") || git.added_files.include?("CHANGELOG.md")
+
+# Don't accept PR on master for now
+fail "Please re-submit this PR to stable, you're trying to merge the PR on master." if github.branch_for_base == "master"
+
+# If these are all empty something has gone wrong, better to raise it in a comment
+if git.modified_files.empty? && git.added_files.empty? && git.deleted_files.empty?
+    fail "This PR has no changes at all, this is likely a developer issue."
+end
+
+# Run SwiftLint
+swiftlint.config_file = '.swiftlint.yml'
+swiftlint.lint_files
+
+# Warn when new tests files were added but the XCTestManifests files wasn't updated
+tests_added = !git.added_files.grep(XCode/Tests/).empty?
+xc_manifest_updated = !git.modified_files.grep(XCode/Tests/XCTestManifests.swift).empty?
+if !tests_added && xc_manifest_updated
+  fail("It seems like new tests files were added to the library. Please update the [XCTestManifests.swift](https://github.com/httpswift/swifter/blob/stable/XCode/Tests/XCTestManifests.swift) file running in your terminal the command `swift test --generate-linuxmain`.")
+  message "Please after you run the command in your terminal remove the `testCase(IOSafetyTests.__allTests__IOSafetyTests),` from the function `public func __allTests() -> [XCTestCaseEntry]` in the bottom of the file."
+end
