vector-im/element-x-ios/issues/14 - Initial Danger setup

2026-11-03 16:10:20 +00:00 · 2022-04-26 17:21:32 +03:00
parent 0a0f41689a
commit 1b1b541a63
6 changed files with 103 additions and 6 deletions
@@ -0,0 +1,77 @@
+import Foundation
+import Danger
+
+SwiftLint.lint(inline: true)
+
+let danger = Danger()
+
+// Warn when there is a big PR
+if (danger.github.pullRequest.additions ?? 0) > 500 {
+    warn("This pull request seems relatively large. Please consider splitting it into multiple smaller ones.")
+}
+
+// Check that the PR has a description
+if danger.github.pullRequest.body?.isEmpty ?? true {
+    warn("Please provide a description for this PR.")
+}
+
+// Request a changelog for each app change
+let editedFiles = danger.git.modifiedFiles + danger.git.createdFiles
+let hasChangelog = danger.git.modifiedFiles.contains("/changelog.d")
+
+if editedFiles.count > 0 && !hasChangelog {
+    warn("Please add a changelog.")
+}
+
+// Check for a ticket number
+if let ticketNumberRegex = try? NSRegularExpression(pattern: "#\\d+") {
+    let missingTicketNumber = !danger.git.commits.filter {
+        !$0.message.contains("vector-im/element-x-ios/issues/") &&
+        ticketNumberRegex.firstMatch(in: $0.message, options: [], range: .init(location: 0, length: $0.message.utf16.count)) == nil
+    }.isEmpty
+    
+    if missingTicketNumber {
+        warn("Some of the commits are missing ticket numbers. Please consinder using them for better tracking.")
+    }
+}
+
+// Check for a sign-off
+let signOff = "Signed-off-by:"
+
+let allowList = ["stefanceriu",
+                 "Johennes",
+                 "yostyle",
+                 "SBiOSoftWhare",
+                 "ismailgulek",
+                 "Anderas",
+                 "pixlwave",
+                 "langleyd",
+                 "manuroe",
+                 "gileluard",
+                 "phlniji",
+                 "MaximeEvrard42",
+                 "aringenbach"]
+
+let requiresSignOff = !allowList.contains(where: {
+    $0.caseInsensitiveCompare(danger.github.pullRequest.user.login) == .orderedSame
+})
+
+if requiresSignOff {
+    let hasPRBodySignOff = danger.github.pullRequest.body?.contains(signOff) ?? false
+
+    let isMissingCommitsSignOff = !danger.git.commits.filter {
+        !$0.message.contains(signOff)
+    }.isEmpty
+
+    if !hasPRBodySignOff && isMissingCommitsSignOff {
+        fail("Please add a sign-off to either the PR description or to the commits themselves.")
+    }
+}
+
+// Check for screenshots on view changes
+let hasChangedViews = !editedFiles.filter { $0.lowercased().contains("/view") }.isEmpty
+if hasChangedViews {
+    if (danger.github.pullRequest.body?.contains("user-images") ?? false) == false {
+        warn("You seem to have made changes to views. Please consider adding screenshots.")
+    }
+}