[#39] Optimize the workflow to generate the "sample" project before executing CI actions

luongvo commented 11 months ago

Close #39

What happened 👀

Modify the test.yml workflow to generate the sample project before executing test actions on Android or iOS platforms.
Add cancel previous runs.
Separate danger report between Android and iOS.
Fix: Running Danger SwiftFormat from the non-root directory.
Add the initial contribution guide for git-submodule.

Insight 📝

The Danger for iOS has an issue when running from the non-root directory: sample/ios, which makes the SwiftFormat can not file expected files because of duplicating the sample/ios path https://github.com/nimblehq/kmm-templates/actions/runs/5982564343/job/16231801560 💥

The cause is while danger-ruby-swiftformat returns the list of swift files with the full path from the root dir, e.g. sample/ios/fastlane/Constants/Constant.swift, including sample/ios, SwiftFormat joins them with the current working dir /Users/runner/work/kmm-templates/kmm-templates/sample/ios/.
There is no official support to bypass this issue. I made a workaround to modify the danger-ruby-swiftformat source to remove the sample/ios prefix from all files by using this operator .map { |file| file.partition('sample/ios/').last } 🙏
```
  files
    .select { |file| file.end_with?(".swift") }
    .reject { |file| @exclude.any? { |glob| File.fnmatch(glob, file) } }
    .uniq.map { |file| file.partition('sample/ios/').last }
    .sort
```

Proof Of Work 📹

The workflow works properly as it is.

luongvo commented 11 months ago

@phongvhd93 @markgravity @kaungkhantsoe This PR is now ready for review, too 🎉

github-actions[bot] commented 11 months ago

	8 Warnings
:warning:	Big PR
:warning:	Uh oh! Your project is under 80% coverage!
:warning:	shared/src/androidMain/kotlin/co/nimblehq/kmm/template/Platform.android.kt#L3 - The file name 'Platform.android' does not match the name of the single top-level declaration 'AndroidPlatform'.
:warning:	shared/src/androidUnitTest/kotlin/co/nimblehq/kmm/template/androidTest.kt#L6 - The file name 'androidTest' does not match the name of the single top-level declaration 'AndroidGreetingTest'.
:warning:	shared/src/commonTest/kotlin/co/nimblehq/kmm/template/commonTest.kt#L6 - The file name 'commonTest' does not match the name of the single top-level declaration 'CommonGreetingTest'.
:warning:	shared/src/commonTest/kotlin/co/nimblehq/kmm/template/extensions/ResponseMappingTest.kt#L18 - Exception is a too generic Exception. Prefer throwing specific exceptions that indicate a specific error case.
:warning:	shared/src/iosMain/kotlin/co/nimblehq/kmm/template/Platform.ios.kt#L5 - The file name 'Platform.ios' does not match the name of the single top-level declaration 'IOSPlatform'.
:warning:	shared/src/iosTest/kotlin/co/nimblehq/kmm/template/iosTest.kt#L6 - The file name 'iosTest' does not match the name of the single top-level declaration 'IosGreetingTest'.

Kover report:

🧛 Unit Tests Code Coverage: `10.68%`

Coverage of Modified Files:

File	Coverage

Modified Files Not Found In Coverage Report:

CONTRIBUTING.md CONTRIBUTING.md Constant.swift DebugProduction.xcconfig DebugStaging.xcconfig Gemfile.lock README.md README.md ReleaseProduction.xcconfig ReleaseStaging.xcconfig project.pbxproj test.yml test.yml

Codebase cunningly covered by count Shroud 🧛

Generated by :no_entry_sign: Danger

github-actions[bot] commented 11 months ago

	1 Warning
:warning:	This pull request is quite big (618 lines changed), please consider splitting it into multiple pull requests.

SwiftFormat found issues:

File	Rules
fastlane/Constants/Constant.swift:122:1	warning: (trailingSpace) Remove trailing space at end of a line.
fastlane/Constants/Constant.swift:129:1	warning: (trailingSpace) Remove trailing space at end of a line.
fastlane/Constants/Constant.swift:145:1	warning: (trailingSpace) Remove trailing space at end of a line.
fastlane/Constants/Constant.swift:153:1	warning: (trailingSpace) Remove trailing space at end of a line.
fastlane/Constants/Constant.swift:160:1	warning: (trailingSpace) Remove trailing space at end of a line.
fastlane/Constants/Constant.swift:164:1	warning: (spaceAroundOperators) Add or remove space around operators or delimiters.
fastlane/Constants/Constant.swift:167:1	warning: (trailingSpace) Remove trailing space at end of a line.

Current coverage for sample is `18.25%`

✅ No files affecting coverage found

Powered by xcov

Generated by :no_entry_sign: Danger

nimblehq / kmm-templates