Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Speaker Deck
PRO
Sign in
Sign up for free
[potatotips #70] license-list-pluginを使ってOSSライセンス画面を自動生成する / license-list-plugin
syarihu
July 10, 2020
Technology
4
2.7k
[potatotips #70] license-list-pluginを使ってOSSライセンス画面を自動生成する / license-list-plugin
オンライン開催されたpotatotips #70で発表した資料です。
https://potatotips.connpass.com/event/178565/
syarihu
July 10, 2020
Tweet
Share
More Decks by syarihu
See All by syarihu
[DroidKaigi 2021] Google Play 定期購入 比例配分モード完全攻略ガイド / Google Play Subscription Proration Mode Complete Guide
syarihu
1
4.8k
[Money Forward Tech Drive] What's new in Google Play [Recap #io21]
syarihu
0
340
[Android 11 Meetups] Google Play Commerce からのアップデート / Android 11 Meetups Google Play Commerce
syarihu
4
2.1k
[potatotips #69] Wi-Fi Suggestion API / Wi-Fi Suggestion API
syarihu
2
1.4k
[DroidKaigi 2020] Re:ゼロから始める Play Billing Library / Re: Zero - starting uses of Play Billing Library
syarihu
0
7.8k
入社から約2年、 Money ForwardのAndroidエンジニアとしての活動を振り返る / Looking back of two years as an Android Engineer of Money Forward
syarihu
1
1.5k
マネーフォワードMEにおける Jetpackの活用事例
syarihu
2
2.3k
Play Billing Library 2.0
syarihu
3
12k
約4年間ConoHaを使っている話
syarihu
0
1.9k
Other Decks in Technology
See All in Technology
Devに力を授けたいSREのあゆみ / SRE that wants to empower developers
tocyuki
3
470
srenext2022-skaru
mixi_engineers
1
510
[SRE NEXT 2022]ヤプリのSREにおけるセキュリティ強化の取り組みを公開する
mmochi23
1
380
Puny to Powerful PostgreSQL Rails Apps
andyatkinson
PRO
0
270
プロダクトグロースと技術のベースアップを両立させるRettyのアプリ開発スタイル / Achieve Product Growth and Tech Update
imaizume
1
290
SRENEXT2022 組織にSREを実装していくまでの道のり
marnie0301
1
320
New Features in C# 10/11
chack411
0
920
mROS 2のススメ
takasehideki
0
300
YAMLを書くだけで構築できる分散ストレージ
sat
PRO
0
180
新規ゲームのリリース(開発)前からのSRE活動
tmkoikee
1
150
モダンデータスタックとかの話(データエンジニアのお仕事とは)
foursue
0
390
スタートアップ入社4日目までに考えたAWSのセキュリティ向上/ Startup AWS Security
shonansurvivors
3
2.9k
Featured
See All Featured
Reflections from 52 weeks, 52 projects
jeffersonlam
337
17k
Fireside Chat
paigeccino
11
1.3k
Embracing the Ebb and Flow
colly
73
3.3k
The World Runs on Bad Software
bkeepers
PRO
56
5.2k
The Most Common Mistakes in Cover Letters
jrick
PRO
4
24k
ReactJS: Keep Simple. Everything can be a component!
pedronauck
655
120k
A Philosophy of Restraint
colly
192
14k
Side Projects
sachag
449
37k
The Pragmatic Product Professional
lauravandoore
19
2.9k
Designing Dashboards & Data Visualisations in Web Apps
destraynor
224
49k
Atom: Resistance is Futile
akmur
255
20k
Music & Morning Musume
bryan
35
4.1k
Transcript
license-list-pluginを使って OSSライセンス画面を自動生成する 2020/07/10 (Fri) potatotips #70 @syarihu
Taichi Sato (@syarihu) • Money Forward, Inc. ◦ Android Engineer
• TechBooster
None
OSSライセンス画面を手軽に作るためのツール • oss-licenses-plugin ◦ Google Play Services • LicenseToolsPlugin ◦
cookpad • license-list-plugin ◦ jmatsu
OSSライセンス画面を作るためのツール • oss-licenses-plugin ◦ Google Play Services • LicenseToolsPlugin ◦
cookpad • license-list-plugin ◦ jmatsu
oss-licenses-plugin • Googleが公式で提供している • ライセンスリストを自動生成、特定のActivityを呼び出す だけ ◦ カスタマイズはできない ◦ UIはちょっと微妙
• 一部ライセンスが表示されないなどの問題があった ◦ 依存関係が多い場合に問題に気づきにくい
None
jmatsu/license-list-plugin • ライセンスリストを自動生成し、yamlに定義ファイルを出 力 ◦ 人が読みやすい形なので、ライセンスの追加/変更/削 除も簡単にできる ◦ oss-license-pluginと違いライセンスリストが隠蔽され ていないため、差分も分かりやすい
license-list-plugin • 定義ファイルを元に表示用のhtmlを自動生成したり、カス タマイズした画面を提供するために利用可能なjsonの出 力も可能 • ローカルライブラリにも対応
license-list-plugin • ライセンスリストから除外したいライブラリがある場合 は.artifactignoreに記述することで簡単に除外可能 • cookpad/LicenseToolsPluginを使っている場合は cookpadのプラグインで利用するlicenses.ymlからの移 行も可能
RecyclerView HTML
license-list-pluginへの移行 • oss-licenses-pluginは便利だが、UIが微妙だったり、一 部ライセンスが表示されないなどの問題があったことか ら、ライセンス定義ファイルを自分で管理できたり、機能 が充実しているlicense-list-pluginへ移行することにした
license-list-pluginをどうやって使っているか • 定義ファイルからjsonに吐き出して、jsonを元に RecyclerViewで画面を構築 ◦ 最初作るのは手間だが、アプリのテーマカラーに合わ せられるし、1回作ってしまえばその後は定義ファイル を更新するだけでOK
license-list-pluginをどうやって使っているか • 依存関係の更新時にライセンスリストを更新するのを忘 れてしまう可能性がある ◦ 依存関係を更新したら自動でライセンス定義ファイル を更新するPRを作成
ライセンス定義ファイルを自動で更新するPRを作成 • 依存関係をまとめたファイルDep.ktが変更されたかを Dangerを使って検知 ◦ 検知したらPRに特定のラベルをつける • GitHub Actionsで特定のラベルがついたときに発火する ワークフローを作成
◦ ライセンスリストを更新して自動でPRを立てるジョブを 作る
Dangerfile - 依存関係が更新されている場合はラベルをつける begin target_branch = github.branch_for_base.match(/release|develop/) is_dependencies_updated = git.modified_files.grep(/.*Dep.kt/).empty?
if target_branch && !is_dependencies_updated pr_number = github.pr_json["number"] auto_label.set(pr_number, "Update licenses", "#1d76db") end end
Dangerfile - 依存関係が更新されている場合はラベルをつける begin target_branch = github.branch_for_base.match(/release|develop/) is_dependencies_updated = git.modified_files.grep(/.*Dep.kt/).empty?
if target_branch && !is_dependencies_updated pr_number = github.pr_json["number"] auto_label.set(pr_number, "Update licenses", "#1d76db") end end
Dangerfile - 依存関係が更新されている場合はラベルをつける begin target_branch = github.branch_for_base.match(/release|develop/) is_dependencies_updated = git.modified_files.grep(/.*Dep.kt/).empty?
if target_branch && !is_dependencies_updated pr_number = github.pr_json["number"] auto_label.set(pr_number, "Update licenses", "#1d76db") end end
Dangerfile - 依存関係が更新されている場合はラベルをつける begin target_branch = github.branch_for_base.match(/release|develop/) is_dependencies_updated = git.modified_files.grep(/.*Dep.kt/).empty?
if target_branch && !is_dependencies_updated pr_number = github.pr_json["number"] auto_label.set(pr_number, "Update licenses", "#1d76db") end end
.github/workflow.yml - ラベルがついたら発火する name: Update license list on: pull_request: types:
- labeled
.github/workflow.yml - 特定のラベルのみジョブを実行する jobs: build: runs-on: ubuntu-latest if: github.event.label.name ==
'Update licenses' steps: - uses: actions/checkout@v2 with: ref: ${{ github.head_ref }} - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8
.github/workflow.yml - 特定のラベルのみジョブを実行する jobs: build: runs-on: ubuntu-latest if: github.event.label.name ==
'Update licenses' steps: - uses: actions/checkout@v2 with: ref: ${{ github.head_ref }} - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8
.github/workflow.yml - ライセンス定義ファイルを更新する - name: Update license list run: |
# ライセンス定義ファイルの差分を更新 ./gradlew mergeReleaseLicenseList # 定義ファイルを元にjsonを更新 ./gradlew visualizeReleaseLicenseList
.github/workflow.yml - ライセンス定義ファイルを更新する - name: Update license list run: |
# ライセンス定義ファイルの差分を更新 ./gradlew mergeReleaseLicenseList # 定義ファイルを元にjsonを更新 ./gradlew visualizeReleaseLicenseList
.github/workflow.yml - ライセンス定義ファイルを更新する - name: Update license list run: |
# ライセンス定義ファイルの差分を更新 ./gradlew mergeReleaseLicenseList # 定義ファイルを元にjsonを更新 ./gradlew visualizeReleaseLicenseList
.github/workflow.yml - 自動でPRを作成する - name: Create Pull Request uses: peter-evans/create-pull-request@v2
with: token: ${{ secrets.REPO_ACCESS_TOKEN }} commit-message: Updated license by license-list-plugin committer: syarihu <info@syarihu.net> author: syarihu <info@syarihu.net> title: Update license body: | This PR has been auto-generated branch: update-license-list branch-suffix: short-commit-hash
.github/workflow.yml - 自動でPRを作成する - name: Create Pull Request uses: peter-evans/create-pull-request@v2
with: token: ${{ secrets.REPO_ACCESS_TOKEN }} commit-message: Updated license by license-list-plugin committer: syarihu <info@syarihu.net> author: syarihu <info@syarihu.net> title: Update license body: | This PR has been auto-generated branch: update-license-list branch-suffix: short-commit-hash
.github/workflow.yml - 自動でPRを作成する - name: Create Pull Request uses: peter-evans/create-pull-request@v2
with: token: ${{ secrets.REPO_ACCESS_TOKEN }} commit-message: Updated license by license-list-plugin committer: syarihu <info@syarihu.net> author: syarihu <info@syarihu.net> title: Update license body: | This PR has been auto-generated branch: update-license-list branch-suffix: short-commit-hash
None
None
ライセンス定義ファイルを自動で更新するPRを作成 • これで依存関係を更新したときに自動でPRが作成される ようになったので、ライセンスの更新忘れも無くなり人間 の手間もほとんど無くなった • コミット時に自動でDeployGateにアップロードしてPRに QRコードがコメントされるようにしているので、差分に問題 がない場合はこれで動作確認をするだけでよくなった。最 高!
まとめ • license-list-pluginを使うと定義ファイルの管理が簡単に なる • json出力すればアプリに合ったテーマのOSSライセンス 画面を構築可能 • ライセンス定義ファイルを自動更新、自動PRすれば手間 も更新忘れも無くなる
参考資料 • jmatsu/license-list-plugin: Gradle plugin to manage licenses of your
Android app's dependencies. ◦ https://github.com/jmatsu/license-list-plugin • Including Open Source Notices ◦ https://developers.google.com/android/guides/opensource • cookpad/LicenseToolsPlugin: Gradle plugin to check library licenses and generate license pages for Android ◦ https://github.com/cookpad/LicenseToolsPlugin
ありがとうございました