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.8k
[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
48
[DroidKaigi 2024] Android ViewからJetpack Composeへ 〜Jetpack Compose移行のすゝめ〜 / From Android View to Jetpack Compose: A Guide to Migration
syarihu
4
3.7k
[shibuya.apk #46] Composableの枠を超えてアニメーションする / Animation beyond Composable
syarihu
0
55
[shibuya.apk #41] Jetpack Composeでグリッドに柔軟にスペースを入れたい
syarihu
0
3.3k
[DroidKaigi 2022] 詳解Google Playの新しい定期購入 ~オファーの活用や実装例を添えて~
syarihu
0
3.6k
5分で分かるGoogle Playの新しいサブスクリプション / Google Play new subscription 2022
syarihu
1
1.8k
[DroidKaigi 2021] Google Play 定期購入 比例配分モード完全攻略ガイド / Google Play Subscription Proration Mode Complete Guide
syarihu
1
7.8k
[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
Railsの限界を超えろ!「家族アルバム みてね」の画像・動画の大規模アップロードを支えるアーキテクチャの変遷
ojima_h
4
510
激動の時代、新卒エンジニアはAIツールにどう向き合うか。 [LayerX Bet AI Day Countdown LT Day1 ツールの選択]
tak848
0
600
Power Automate のパフォーマンス改善レシピ / Power Automate Performance Improvement Recipes
karamem0
0
260
【CEDEC2025】現場を理解して実現!ゲーム開発を効率化するWebサービスの開発と、利用促進のための継続的な改善
cygames
PRO
0
290
From Live Coding to Vibe Coding with Firebase Studio
firebasethailand
1
290
ObsidianをLLM時代のナレッジベースに! クリッピング→Markdown→CLI連携の実践
srvhat09
7
9.7k
Shadow DOM & Security - Exploring the boundary between light and shadow
masatokinugawa
0
750
今日からあなたもGeminiを好きになる
subaruhello
1
650
[TechNight #91] Oracle Database 最新パフォーマンス分析手法
oracle4engineer
PRO
2
120
The Madness of Multiple Gemini CLIs Developing Simultaneously with Jujutsu
gunta
1
2.8k
AIに全任せしないコーディングとマネジメント思考
kikuchikakeru
0
260
Datasets for Critical Operations by Dataform
kimujun
0
110
Featured
See All Featured
Save Time (by Creating Custom Rails Generators)
garrettdimon
PRO
31
1.3k
Being A Developer After 40
akosma
90
590k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
21
1.4k
GraphQLの誤解/rethinking-graphql
sonatard
71
11k
What’s in a name? Adding method to the madness
productmarketing
PRO
23
3.6k
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
18
1k
Why Our Code Smells
bkeepers
PRO
337
57k
Building Applications with DynamoDB
mza
95
6.5k
Music & Morning Musume
bryan
46
6.7k
Measuring & Analyzing Core Web Vitals
bluesmoon
7
530
Designing Experiences People Love
moore
142
24k
Statistics for Hackers
jakevdp
799
220k
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
ありがとうございました