Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
[potatotips #70] license-list-pluginを使ってOSSライセン...
Search
syarihu
July 10, 2020
Technology
4
4.9k
[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
Recap #io25 What's new in Google Play
syarihu
0
62
[DroidKaigi 2024] Android ViewからJetpack Composeへ 〜Jetpack Compose移行のすゝめ〜 / From Android View to Jetpack Compose: A Guide to Migration
syarihu
4
3.9k
[shibuya.apk #46] Composableの枠を超えてアニメーションする / Animation beyond Composable
syarihu
0
65
[shibuya.apk #41] Jetpack Composeでグリッドに柔軟にスペースを入れたい
syarihu
0
3.4k
[DroidKaigi 2022] 詳解Google Playの新しい定期購入 ~オファーの活用や実装例を添えて~
syarihu
0
3.7k
5分で分かるGoogle Playの新しいサブスクリプション / Google Play new subscription 2022
syarihu
1
1.9k
[DroidKaigi 2021] Google Play 定期購入 比例配分モード完全攻略ガイド / Google Play Subscription Proration Mode Complete Guide
syarihu
1
7.9k
[Money Forward Tech Drive] What's new in Google Play [Recap #io21]
syarihu
0
590
[Android 11 Meetups] Google Play Commerce からのアップデート / Android 11 Meetups Google Play Commerce
syarihu
4
2.9k
Other Decks in Technology
See All in Technology
From Prompt to Product @ How to Web 2025, Bucharest, Romania
janwerner
0
120
Why Governance Matters: The Key to Reducing Risk Without Slowing Down
sarahjwells
0
100
10年の共創が示す、これからの開発者と企業の関係 ~ Crossroad
soracom
PRO
1
170
GC25 Recap+: Advancing Go Garbage Collection with Green Tea
logica0419
1
400
KMP の Swift export
kokihirokawa
0
330
OpenAI gpt-oss ファインチューニング入門
kmotohas
2
940
ZOZOのAI活用実践〜社内基盤からサービス応用まで〜
zozotech
PRO
0
160
AI ReadyなData PlatformとしてのAutonomous Databaseアップデート
oracle4engineer
PRO
0
170
リーダーになったら未来を語れるようになろう/Speak the Future
sanogemaru
0
270
Trust as Infrastructure
bcantrill
0
310
いまさら聞けない ABテスト入門
skmr2348
1
200
stupid jj tricks
indirect
0
7.9k
Featured
See All Featured
[RailsConf 2023 Opening Keynote] The Magic of Rails
eileencodes
31
9.7k
Dealing with People You Can't Stand - Big Design 2015
cassininazir
367
27k
Building an army of robots
kneath
306
46k
Bash Introduction
62gerente
615
210k
Fashionably flexible responsive web design (full day workshop)
malarkey
407
66k
The Cult of Friendly URLs
andyhume
79
6.6k
Building a Modern Day E-commerce SEO Strategy
aleyda
43
7.7k
Music & Morning Musume
bryan
46
6.8k
Documentation Writing (for coders)
carmenintech
75
5k
Practical Orchestrator
shlominoach
190
11k
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
marcduiker
32
2.2k
VelocityConf: Rendering Performance Case Studies
addyosmani
332
24k
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 <
[email protected]
> author: syarihu <
[email protected]
> 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 <
[email protected]
> author: syarihu <
[email protected]
> 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 <
[email protected]
> author: syarihu <
[email protected]
> 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
ありがとうございました