Dangerfile 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. ### Helper functions
  2. # Determine if any of the files were changed or deleted.
  3. # Taken from samdmarshall/danger
  4. def didModify(files_array)
  5. files_array.each do |file_name|
  6. if git.modified_files.include?(file_name) ||
  7. git.deleted_files.include?(file_name)
  8. return true
  9. end
  10. end
  11. return false
  12. end
  13. # Determine if there are changes in files matching any of the
  14. # path patterns provided.
  15. def hasChangesIn(paths)
  16. path_array = Array(paths)
  17. path_array.each do |dir|
  18. if !git.modified_files.grep(/#{dir}/).empty?
  19. return true
  20. end
  21. end
  22. return false
  23. end
  24. # Adds the provided labels to the current PR.
  25. def addLabels(label_array)
  26. issue_number = github.pr_json["number"]
  27. repo_name = "firebase/firebase-ios-sdk"
  28. github.api.add_labels_to_an_issue(repo_name, issue_number, label_array)
  29. end
  30. # Returns a list of all labels for a given PR. PRs that touch
  31. # multiple directories may have multiple labels.
  32. def labelsForModifiedFiles()
  33. labels = []
  34. labels.push("api: abtesting") if @has_abtesting_changes
  35. labels.push("api: auth") if @has_auth_changes
  36. labels.push("api: core") if @has_core_changes
  37. labels.push("api: crashlytics") if @has_crashlytics_changes
  38. labels.push("api: database") if @has_database_changes
  39. labels.push("api: dynamiclinks") if @has_dynamiclinks_changes
  40. labels.push("api: firestore") if @has_firestore_changes
  41. labels.push("api: functions") if @has_functions_changes
  42. labels.push("api: inappmessaging") if @has_inappmessaging_changes
  43. labels.push("api: installations") if @has_installations_changes
  44. labels.push("api: instanceid") if @has_instanceid_changes
  45. labels.push("api: messaging") if @has_messaging_changes
  46. labels.push("api: remoteconfig") if @has_remoteconfig_changes
  47. labels.push("api: storage") if @has_storage_changes
  48. labels.push("GoogleDataTransport") if @has_gdt_changes
  49. labels.push("GoogleUtilities") if @has_googleutilities_changes
  50. labels.push("zip-builder") if @has_zipbuilder_changes
  51. labels.push("public-api-change") if @has_api_changes
  52. return labels
  53. end
  54. ### Definitions
  55. # Label for any change that shouldn't have an accompanying CHANGELOG entry,
  56. # including all changes that do not affect the compiled binary (i.e. script
  57. # changes, test-only changes)
  58. declared_trivial = github.pr_body.include? "#no-changelog"
  59. # Whether or not there are pending changes to any changelog file.
  60. has_changelog_changes = hasChangesIn(["CHANGELOG"])
  61. # Whether or not the LICENSE file has been modified or deleted.
  62. has_license_changes = didModify(["LICENSE"])
  63. ## Product directories
  64. @has_abtesting_changes = hasChangesIn("FirebaseABTesting/")
  65. @has_abtesting_api_changes = hasChangesIn("FirebaseABTesting/Sources/Public/")
  66. @has_auth_changes = hasChangesIn("FirebaseAuth")
  67. @has_auth_api_changes = hasChangesIn("FirebaseAuth/Sources/Public/")
  68. @has_core_changes = hasChangesIn([
  69. "FirebaseCore/",
  70. "Firebase/CoreDiagnostics/",
  71. "CoreOnly/"])
  72. @has_core_api_changes = hasChangesIn("FirebaseCore/Sources/Public/")
  73. @has_crashlytics_changes = hasChangesIn("Crashlytics/")
  74. @has_crashlytics_api_changes = hasChangesIn("Crashlytics/Crashlytics/Public/")
  75. @has_database_changes = hasChangesIn("Firebase/Database/")
  76. @has_database_api_changes = hasChangesIn("Firebase/Database/Public/")
  77. @has_dynamiclinks_changes = hasChangesIn("FirebaseDynamicLinks/")
  78. @has_dynamiclinks_api_changes = hasChangesIn("FirebaseDynamicLinks/Sources/Public/")
  79. @has_firestore_changes = hasChangesIn("Firestore/")
  80. @has_firestore_api_changes = hasChangesIn("Firestore/Source/Public/")
  81. @has_functions_changes = hasChangesIn("Functions/")
  82. @has_functions_api_changes = hasChangesIn("Functions/FirebaseFunctions/Public/")
  83. @has_inappmessaging_changes = hasChangesIn(["FirebaseInAppMessaging/"])
  84. @has_inappmessaging_api_changes = hasChangesIn(["FirebaseInAppMessaging/Sources/Public/"])
  85. @has_installations_changes = hasChangesIn("FirebaseInstallations/Source/")
  86. @has_installations_api_changes = hasChangesIn("FirebaseInstallations/Source/Library/Public/")
  87. @has_instanceid_changes = hasChangesIn("Firebase/InstanceID/")
  88. @has_instanceid_api_changes = hasChangesIn("Firebase/InstanceID/Public/")
  89. @has_messaging_changes = hasChangesIn("Firebase/Messaging/")
  90. @has_messaging_api_changes = hasChangesIn("Firebase/Messaging/Public/")
  91. @has_remoteconfig_changes = hasChangesIn("FirebaseRemoteConfig/")
  92. @has_remoteconfig_api_changes = hasChangesIn("FirebaseRemoteConfig/Sources/Public/")
  93. @has_storage_changes = hasChangesIn("FirebaseStorage/")
  94. @has_storage_api_changes = hasChangesIn("FirebaseStorage/Sources/Public/")
  95. @has_gdt_changes = hasChangesIn(["GoogleDataTransport/", "GoogleDataTransportCCTSupport/"])
  96. @has_gdt_api_changes = hasChangesIn("GoogleDataTransport/GDTCORLibrary/Public")
  97. @has_googleutilities_changes = hasChangesIn("GoogleUtilities/")
  98. @has_zipbuilder_changes = hasChangesIn("ZipBuilder/")
  99. # Convenient flag for all API changes.
  100. @has_api_changes = @has_abtesting_api_changes ||
  101. @has_auth_api_changes ||
  102. @has_core_api_changes ||
  103. @has_crashlytics_api_changes ||
  104. @has_database_api_changes ||
  105. @has_dynamiclinks_api_changes ||
  106. @has_firestore_api_changes ||
  107. @has_functions_api_changes ||
  108. @has_inappmessaging_api_changes ||
  109. @has_installations_api_changes ||
  110. @has_instanceid_api_changes ||
  111. @has_messaging_api_changes ||
  112. @has_remoteconfig_api_changes ||
  113. @has_storage_api_changes ||
  114. @has_gdt_api_changes
  115. # A FileList containing ObjC, ObjC++ or C++ changes.
  116. sdk_changes = (git.modified_files +
  117. git.added_files +
  118. git.deleted_files).select do |line|
  119. line.end_with?(".h") ||
  120. line.end_with?(".m") ||
  121. line.end_with?(".mm") ||
  122. line.end_with?(".cc") ||
  123. line.end_with?(".swift")
  124. end
  125. # Whether or not the PR has modified SDK source files.
  126. has_sdk_changes = sdk_changes.empty?
  127. ### Actions
  128. # Warn if a changelog is left out on a non-trivial PR that has modified
  129. # SDK source files (podspec, markdown, etc changes are excluded).
  130. if has_sdk_changes
  131. if !has_changelog_changes && !declared_trivial
  132. warning = "Did you forget to add a changelog entry? (Add #no-changelog"\
  133. " to the PR description to silence this warning.)"
  134. warn(warning)
  135. end
  136. end
  137. # Error on license edits
  138. fail("LICENSE changes are explicitly disallowed.") if has_license_changes
  139. # Label PRs based on diff files
  140. suggested_labels = labelsForModifiedFiles()
  141. if !suggested_labels.empty?
  142. addLabels(suggested_labels)
  143. end