Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yhkaplan/automation-presentation-2019-02-21
https://github.com/yhkaplan/automation-presentation-2019-02-21
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/yhkaplan/automation-presentation-2019-02-21
- Owner: yhkaplan
- Created: 2019-02-18T04:57:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-20T11:59:08.000Z (almost 6 years ago)
- Last Synced: 2024-11-06T05:42:20.888Z (3 months ago)
- Size: 1.72 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
slidenumbers: true
# [fit] Automate all the things
---
# [fit] あらゆる作業を自動化しよう
---
# Self Intro
- Joshua Kaplan
- minne @ GMO Pepabo
- Danger-Swift contributer
- Likes 🤖
^ 日本最大のハンドメイドマーケットプレイスである minne の iOS エンジニア
本日発表する Danger の contributer
機械に仕事をしてもらうのが好き
---
# [fit] CI is the ultimate automation tool
^ CI が最強の自動化ツールである
---
# [fit] Why?
---
- Fewer mistakes
- Faster
- More efficient
- More exciting
^ App Store Connect にログインするのが好きな人いる？
---
# Key CI tools
- Fastlane
- Danger
- SwiftLint
---
# [fit] Normal CI flow (level 1)
---
# Run tests for each PR
^ Github につなげて、単体テストをすべての PR に対して実行する
これを code review と組み合わせて、品質を担保する
---
---
# [fit] Intermediate CI flow (level 2)
^ それだけではない
---
# [fit] Linters and other static analysis
^ linter などの静的解析ツールにより、さらなる品質とレビューの自動化を実現できる
---
# SwiftLint + Danger
^ これだいたい知られているやつ
```rb
swiftlint.lint_files inline_mode: true
```
---
---
# Check storyboards
^ storyboard の簡易な linter も行える
本当はツールあるが、とりあえずこれだけでよい
---
```rb
# storyboardにずれているビューや制約の不備がないか
parsed_diff.each do |changed_file|
next unless changed_file.file.match(/.*\.(storyboard)$/)
changed_file.changed_lines.each do |changed_line|
content = changed_line.content
has_misplaced_view = content.include? 'misplaced="YES"'
has_ambiguous_view = content.include? 'ambiguous="YES"'
file = changed_file.file
line_number = changed_line.number
if has_misplaced_view
fail('ずれているビューがあるので、Update Framesを実行してください', file: file, line: line_number)
end
if has_ambiguous_view
fail('制約が不十分な箇所があるので、直してください', file: file, line: line_number)
end
end
end
```
---
# Spell checking
^ 私が職場で唯一の英語ネーティブなので、スペルに厳しいやつとして見られた
スペルの間違いは私がいつも気づくからだ
エンジニアは機械に怒られることにとっても慣れているので、ボットにやらせることで、自分の厳しい印象を払拭して、自分の仕事を楽にした
cspell という JS のツールを使っている. Xcode には spell check のメニュー項目はあるが、機能しない
---
---
```rb
# タイポを検知する
added_and_modified_files = git.added_files + git.modified_files
added_and_modified_files.each do |file_path|
next unless file_path =~ /\.swift$/
stdout, status = Open3.capture2("npx", "cspell", file_path)
next if status.success?
stdout.split("\n").each do |line|
next unless matches = /\w+\.swift:(\d+).*-\sUnknown\sword\s\((\w+)\)/.match(line)
line_number = matches[1].to_i
word = matches[2]
warning = "タイポかも？ #{word}"
warn(warning, file: file_path, line: line_number)
end
end
```
---
# [fit] Automate PR tasks
---
# Assign reviewers
---
```rb
# レビュワー指定（コメント指定のためにこれを一番上に書く必要あり）
reviewers = ["user1", "user2", "user3"].reject { |reviewer| reviewer == github.pr_author }
repo_name = github.pr_json["head"]["repo"]["full_name"]
pr_number = github.pr_json["number"]
number_of_comments = github.api.issue_comments(repo_name, pr_number).size
if number_of_comments.zero?
reviewers = reviewers.sample(2)
github.api.request_pull_request_review(
repo_name,
pr_number,
{},
"reviewers": reviewers
)
end
```
---
# Post CI results
^ CI のログを見に行く時間を減らすと楽
また、某 B 社のちょっと遅いログのロード時間を省ける
---
---
```rb
# Xcode Summary
build_report_file = 'build_results.json'
xcode_summary.ignored_files = 'Pods/**'
xcode_summary.ignores_warnings = true
xcode_summary.inline_mode = true
xcode_summary.report build_report_file
```
---
# Post code coverage
^ 絵文字でテストを書くモチベーションをあげる
また、最低のカバレッジを設定できるので、品質管理の面でも効果的
---
---
```rb
xcov.report(
scheme: 'minne',
workspace: 'minne.xcworkspace',
exclude_targets: 'TodayExtension.appex, NotificationServiceExtension.appex, MinneKit.framework',
)
```
---
# [fit] Advanced CI flow (level 3)
---
# Custom SwiftLint rules
^ すべての会社には、特定のルールやベストプラクティスがあるので、custom ルールでそのルールの遵守を担保できる
---
```yml
prefer_gregorian_calendar:
name: "Gregorian Calendar"
regex: "Calendar\\.current"
message: "Please use `Calendar(identifier: .gregorian)` to avoid Japanese calendar-related bugs"
severity: error
https_only:
name: "HTTPS Only"
match_kinds:
- string # コメントなどを無視して、文字列のみをみる
regex: "http:"
message: "Please use HTTPS due to security policy"
severity: error
```
---
# Deliver beta and release builds
^ ローカル端末で xcode archive している人いますか？
それだと、作業をローカルでできないので、CI が効率よい
---
```rb
lane :release do
capture_screenshots # generate new screenshots for the App Store
sync_code_signing(type: "appstore") # see code signing guide for more information
build_app(scheme: "MyApp")
upload_to_app_store # upload your app to App Store Connect
slack(message: "Successfully uploaded a new App Store build")
end
```
---
# Automate screenshot delivery
^ 使っていないが、多言語対応の場合は本当に必須
---
```swift
// App
let app = XCUIApplication()
setupSnapshot(app)
app.launch()
```
```rb
# Fastlane
lane :screenshots do
capture_screenshots
frame_screenshots(white: true)
upload_to_app_store
end
```
---
# Check for dead code
^ minne では Swift 化を積極的に行なっているので、使われていないコードに時間をかけて、Swift 化したら、もったいない
本当は Go の linter みたいに PR で確認したいけど、Periphery はビルドが必要なので、定期実行にしている
---
## 
---
```rb
def get_dead_objc_code
std_out, status = Open3.capture2("bundle", "exec", "fui", "--ignorexib", "--path", "minne/Classes")
# fuiのexitstatusは、使われていないクラスの数で、
# Bridging-Headerが必ず当たってしまうので、
# 2つ以上の結果がある場合通知している。
return status.exitstatus >= 2 ? std_out : ""
end
def get_dead_swift_code
std_out, _ = Open3.capture2("periphery", "scan")
r = /minne.*(Struct|Class) .*is unused$/
filtered_results_array = std_out.to_enum(:scan,r).map {$&}.flatten
return filtered_results_array.join("\n")
end
# Main
dead_objc_result = get_dead_objc_code
dead_swift_result = get_dead_swift_code
mention = ""
message = "#{mention}, Unused files exist:\n"
notify_slack(message + dead_objc_result) unless dead_objc_result == ""
notify_slack(message + dead_swift_result) unless dead_swift_result == ""
```
---
# Release tag generation
^ trigger が master へのマージ
---
---
---
# [fit] Speed optimization
---
# Rome
- https://github.com/blender/Rome
^ CI の時間を半分にした
---
# Dynamic code coverage
^ カバレッジをとると、ビルドが数分長くなってしまうので、Swift ファイルが変更された場合のみにしたり、すると、CI の時間を減らせる
---
# [fit] Conclusion
---
# [fit] Automate all the things