Renovateで依存ライブラリをリノベーションしよう 〜 Bitbucket編 〜

2020/01/30
このエントリーをはてなブックマークに追加

イメージ

こんにちは、Kabuku Connectのバックエンドを担当している金子です。
年末の開発者ブログ執筆ラッシュに乗り遅れたため冬季合宿中にこれを書いています😫

はじめに

ソフトウェア開発にあたり、オープンソースのフレームワークやライブラリはなくてはならないものです。
広く使われているオープンソースのフレームワークやライブラリは世界中の人々の貢献によって高い品質が保たれているものが多いですが、それでもバグや脆弱性は含まれており日々修正が行われています。
そのため普段のソフトウェア開発の合間に使用フレームワークや依存ライブラリの更新情報を調べ、致命的な問題があった時は対処する必要があります。

この対処はパッケージマネージャーの発達により1コマンド ( yarn upgradepoetry update など)で出来るようになりましたが、自分で定期的にコマンドを打ち込んでリポジトリにコミットして対応するのも億劫です。
ありがたいことに世の中にはこういった作業を肩代わりしてくれる以下のようなサービスがあります。

ではこれらを導入すれば解決かと言うと必ずしもそうも行きません。
これらはほぼGitHub向けに展開されているサービスです(DependabotはGitHubが買収しました)
ソースコードのバージョン管理自体は最近ではgitを使っている所が大半だと思いますが、様々な理由によりGitHub以外で管理している所も多いと思います。
例えばカブクではBitbucket Cloud(以下Bitbucket)を使用しており、上記のサービスが直接使えないため一手間かける必要があります。

今回はDockerイメージを公開していてBitbucketに対応しているRenovateを使い、Bitbucket上で管理しているソースコードの依存ライブラリの更新をGoogle Cloud PlatformのCloud Buildから行う方法を紹介します。

今回の作業に必要なもの

必要なものは以下のものだけです。

  • Docker
  • Bitbucketのアカウント
  • Google Cloud Platformのアカウント
  • Google Cloud SDK

この例ではBitbucketのユーザーを build_user 、 依存ライブラリを更新する対象のリポジトリを app_repository としています。
Bitbucket上の app_repository は既にCloud Source Repositoriesにミラーリング済みであるものとします。
Renovateのバージョンは2020年1月現在の最新、19.107を使用しています。

RenovateのDockerイメージからBitbucketに接続する

Bitbucketのアプリパスワードを発行する

RenovateからBitbucketを操作するにはBitbucketのアプリパスワードが必要になるので発行します。
画面左下のアカウントアイコンをクリックし、メニューから Bitbucket settings を選択します。

Bitbucketのアカウントメニュー

次に アクセス管理 の下の アプリパスワード を選択し、アプリパスワードの作成ボタンを押します。

Bitbucketの設定画面のメニュー

ラベル(この例ではrenovate)と権限を設定し、作成ボタンを押します。
必要な権限はプルリクエストの読み取り書き込みと、課題の読み取り書き込みです。

アプリパスワード作成

作成するとBitbucketが発行したアプリパスワードが表示されたモーダルが出ます。

アプリパスワードのモーダル

このアプリパスワードは発行時しか表示されないので忘れてしまった場合は再発行が必要になります。
必ず控えておきましょう。

Renovateの設定を追加する

Renovateによるライブラリアップデートの設定を以下のようなjsonで定義します。ファイル名は renovate.jsonです。

{
    "extends": ["config:base", ":semanticCommitTypeAll(chore)"],
    "pipenv": {
        "enabled": true
    }
}

設定の詳細についてはドキュメントを参照してください。
https://docs.renovatebot.com/configuration-options/

ローカルでRenovateを実行して確認する

ローカルで以下のコマンドを実行してRenovateからBitbucketへの接続と、ライブラリアップデートのプルリクエストの作成が正しく行われるか確認します。
この時 --dry-run=true を設定しないとプルリクエストが作られてしまうので注意してください。

$ docker run --rm renovate/renovate:19.107 \
  --platform=bitbucket \
  --user_name=build_user \
  --password=<アプリパスワード> \
  --dry-run=true kabuku/app_repository

Cloud BuildからRenovateを実行する

Cloud KMSを使用してBitbucketのアプリパスワードを暗号化する

Bitbucketのアプリパスワードをコマンドの引数に含めるとそのままCloud Buildのビルドログに載ってしまうため、Cloud KMSを使用して暗号化した環境変数としてCloud Buildに渡す必要があります。
ここではKeyRingの名前を app_keyring 、 CryptoKeyの名前を bitbucket_app_key とします。

まずはKeyRingを作成します。既に作成済みの場合は不要です。

$ gcloud kms keyrings create app_keyring --location=global

次にCryptoKeyを作成します。

$ gcloud kms keys create bitbucket_app_key --location=global \
  --keyring=app_keyring --purpose=encryption

最後にBitbucketのアプリパスワードを暗号化し、その結果をBase64エンコードします。

$ echo -n <アプリパスワード> | gcloud kms encrypt \
  --plaintext-file=- \
  --ciphertext-file=- \
  --keyring=app_keyring  \
  --key=bitbucket_app_key | base64

Cloud Buildのビルドステップの定義を追加する

以下のyamlファイルを作成します。ここでは cloudbuild-renovate.yaml としますが、ファイル名は何でも構いません。

steps:
- name: "renovate/renovate:19.107"
  args: ["--platform=bitbucket", "--username=build_user", "--password=$$FOR_RENOVATE_TOKEN", "kabuku/app_repository"]
- kmsKeyName: projects/[PROJECT_ID]/locations/global/keyRings/app_keyring/cryptoKeys/bitbucket_app_key
  secretEnv:
    FOR_RENOVATE_TOKEN: "<暗号化したアプリパスワードをbase64エンコードした文字列>"

ビルドトリガーを作成する

この例ではmasterブランチにpushが行われた時に前項で作成した cloudbuild-renovate.yaml で定義したビルド設定を実行するトリガーを作成します。

Cloud Buildのビルドトリガー

定期的に実行したいのですが、Cloud Buildのトリガーはブランチへのpushまたはタグが打たれた時のみなのが少し悩ましいところです。
Cloud Scheduler等でAPIを叩いてこのトリガーを実行するしかなさそうです。

このビルドトリガーを実行するとRenovateによって下のスクリーンショットのようなプルリクエストが作られます。

Renovateが作ったプルリクエスト

CIの結果を確認して問題なさそうならマージします。楽チンですね!
(もちろんCIが失敗したら何らかの対処をする必要があります)

終わりに

  • この記事の執筆は開発合宿中に終わりませんでした😢
  • カブクではカブいたものやカブいたことが好きなエンジニアを募集しています。


(※この写真は開発合宿先の観光協会の方の許可を得た上で撮影しています)

その他の記事

Other Articles

2020/06/16
[Web フロントエンド] esbuild が爆速すぎて webpack / Rollup にはもう戻れない

2020/03/19
[Web フロントエンド] Elm に心折れ Mint に癒しを求める

2020/02/28
さようなら、TypeScript enum

2020/02/14
受付のLooking Glassに加えたひと工夫

2020/01/28
カブクエンジニア開発合宿に行ってきました 2020冬

2019/12/27
Cloud Tasks でも deferred ライブラリが使いたい

2019/12/25
*, ::before, ::after { flex: none; }

2019/12/21
Top-level awaitとDual Package Hazard

2019/12/20
Three.jsからWebGLまで行きて帰りし物語

2019/12/18
Three.jsに入門+手を検出してAR.jsと組み合わせてみた

2019/12/04
WebXR AR Paint その2

2019/11/06
GraphQLの入門書を翻訳しました

2019/09/20
Kabuku Connect 即時見積機能のバックエンド開発

2019/08/14
Maker Faire Tokyo 2019でARゲームを出展しました

2019/07/25
夏休みだョ!WebAssembly Proposal全員集合!!

2019/07/08
鵜呑みにしないで! —— 書籍『クリーンアーキテクチャ』所感 ≪null 篇≫

2019/07/03
W3C Workshop on Web Games参加レポート

2019/06/28
TypeScriptでObject.assign()に正しい型をつける

2019/06/25
カブクエンジニア開発合宿に行ってきました 2019夏

2019/06/21
Hola! KubeCon Europe 2019の参加レポート

2019/06/19
Clean Resume きれいな環境できれいな履歴書を作成する

2019/05/20
[Web フロントエンド] 状態更新ロジックをフレームワークから独立させる

2019/04/16
C++のenable_shared_from_thisを使う

2019/04/12
OpenAPI 3 ファーストな Web アプリケーション開発(Python で API 編)

2019/04/08
WebGLでレイマーチングを使ったCSGを実現する

2019/04/02
『エンジニア採用最前線』に感化されて2週間でエンジニア主導の求人票更新フローを構築した話

2019/03/29
その1 Jetson TX2でk3s(枯山水)を動かしてみた

2019/03/27
任意のブラウザ上でJestで書いたテストを実行する

2019/02/08
TypeScript で “radian” と “degree” を間違えないようにする

2019/02/05
Python3でGoogle Cloud ML Engineをローカルで動作する方法

2019/01/18
SIGGRAPH Asia 2018 参加レポート

2019/01/08
お正月だョ!ECMAScript Proposal全員集合!!

2019/01/08
カブクエンジニア開発合宿に行ってきました 2018秋

2018/12/25
OpenAPI 3 ファーストな Web アプリケーション開発(環境編)

2018/12/23
いまMLKitカスタムモデル(TF Lite)は使えるのか

2018/12/21
[IoT] Docker on JetsonでMQTTを使ってCloud IoT Coreと通信する

2018/12/11
TypeScriptで実現する型安全な多言語対応(Angularを例に)

2018/12/05
GASでCompute Engineの時間に応じた自動停止/起動ツールを作成する 〜GASで簡単に好きなGoogle APIを叩く方法〜

2018/12/02
single quotes な Black を vendoring して packaging

2018/11/14
3次元データに2次元データの深層学習の技術(Inception V3, ResNet)を適用

2018/11/04
Node Knockout 2018 に参戦しました

2018/10/24
SIGGRAPH 2018参加レポート-後編(VR/AR)

2018/10/11
Angular 4アプリケーションをAngular 6に移行する

2018/10/05
SIGGRAPH 2018参加レポート-特別編(VR@50)

2018/10/03
Three.jsでVRしたい

2018/10/02
SIGGRAPH 2018参加レポート-前編

2018/09/27
ズーム可能なSVGを実装する方法の解説

2018/09/25
Kerasを用いた複数入力モデル精度向上のためのTips

2018/09/21
競技プログラミングの勉強会を開催している話

2018/09/19
Ladder Netwoksによる半教師あり学習

2018/08/10
「Maker Faire Tokyo 2018」に出展しました

2018/08/02
Kerasを用いた複数時系列データを1つの深層学習モデルで学習させる方法

2018/07/26
Apollo GraphQLでWebサービスを開発してわかったこと

2018/07/19
【深層学習】時系列データに対する1次元畳み込み層の出力を可視化

2018/07/11
きたない requirements.txt から Pipenv への移行

2018/06/26
CSS Houdiniを味見する

2018/06/25
不確実性を考慮した時系列データ予測

2018/06/20
Google Colaboratory を自分のマシンで走らせる

2018/06/18
Go言語でWebAssembly

2018/06/15
カブクエンジニア開発合宿に行ってきました 2018春

2018/06/08
2018 年の tree shaking

2018/06/07
隠れマルコフモデル 入門

2018/05/30
DASKによる探索的データ分析(EDA)

2018/05/10
TensorFlowをソースからビルドする方法とその効果

2018/04/23
EGLとOpenGLを使用するコードのビルド方法〜libGLからlibOpenGLへ

2018/04/23
技術書典4にサークル参加してきました

2018/04/13
Python で Cura をバッチ実行するためには

2018/04/04
ARCoreで3Dプリント風エフェクトを実現する〜呪文による積層造形映像制作の舞台裏〜

2018/04/02
深層学習を用いた時系列データにおける異常検知

2018/04/01
音声ユーザーインターフェースを用いた新方式積層造形装置の提案

2018/03/31
Container builderでコンテナイメージをBuildしてSlackで結果を受け取る開発スタイルが捗る

2018/03/23
ngUpgrade を使って AngularJS から Angular に移行

2018/03/14
Three.jsのパフォーマンスTips

2018/02/14
C++17の新機能を試す〜その1「3次元版hypot」

2018/01/17
時系列データにおける異常検知

2018/01/11
異常検知の基礎

2018/01/09
three.ar.jsを使ったスマホAR入門

2017/12/17
Python OpenAPIライブラリ bravado-core の発展的な使い方

2017/12/15
WebAssembly(wat)を手書きする

2017/12/14
AngularJS を Angular に移行: ng-annotate 相当の機能を TypeScrpt ファイルに適用

2017/12/08
Android Thingsで4足ロボットを作る ~ Android ThingsとPCA9685でサーボ制御)

2017/12/06
Raspberry PIとDialogflow & Google Cloud Platformを利用した、3Dプリンターボット(仮)の開発 (概要編)

2017/11/20
カブクエンジニア開発合宿に行ってきました 2017秋

2017/10/19
Android Thingsを使って3Dプリント戦車を作ろう ① ハードウェア準備編

2017/10/13
第2回 魁!! GPUクラスタ on GKE ~PodからGPUを使う編~

2017/10/05
第1回 魁!! GPUクラスタ on GKE ~GPUクラスタ構築編~

2017/09/13
「Maker Faire Tokyo 2017」に出展しました。

2017/09/11
PyConJP2017に参加しました

2017/09/08
bravado-coreによるOpenAPIを利用したPythonアプリケーション開発

2017/08/23
OpenAPIのご紹介

2017/08/18
EuroPython2017で2名登壇しました。

2017/07/26
3DプリンターでLチカ

2017/07/03
Three.js r86で何が変わったのか

2017/06/21
3次元データへの深層学習の適用

2017/06/01
カブクエンジニア開発合宿に行ってきました 2017春

2017/05/08
Three.js r85で何が変わったのか

2017/04/10
GCPのGPUインスタンスでレンダリングを高速化

2017/02/07
Three.js r84で何が変わったのか

2017/01/27
Google App EngineのFlexible EnvironmentにTmpfsを導入する

2016/12/21
Three.js r83で何が変わったのか

2016/12/02
Three.jsでのクリッピング平面の利用

2016/11/08
Three.js r82で何が変わったのか

2016/12/17
SIGGRAPH 2016 レポート

2016/11/02
カブクエンジニア開発合宿に行ってきました 2016秋

2016/10/28
PyConJP2016 行きました

2016/10/17
EuroPython2016で登壇しました

2016/10/13
Angular 2.0.0ファイナルへのアップグレード

2016/10/04
Three.js r81で何が変わったのか

2016/09/14
カブクのエンジニアインターンシッププログラムについての詩

2016/09/05
カブクのエンジニアインターンとして3ヶ月でやった事 〜高橋知成の場合〜

2016/08/30
Three.js r80で何が変わったのか

2016/07/15
Three.js r79で何が変わったのか

2016/06/02
Vulkanを試してみた

2016/05/20
MakerGoの作り方

2016/05/08
TensorFlow on DockerでGPUを使えるようにする方法

2016/04/27
Blenderの3DデータをMinecraftに送りこむ

2016/04/20
Tensorflowを使ったDeep LearningにおけるGPU性能調査

→
←

関連職種

Recruit

バックエンドエンジニア(Python・Go)

業務内容

当ポジションは弊社Webサービスのバックエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工数見積もりを行います。 全ての開発コードはレビューと自動テストによって品質を保っています。 また、リファクタリングやフレームワークのバージョンアップも開発フローに組込み、技術的負債を放置しない開発を目指しています。

フロントエンドエンジニア(TypeScript)

業務内容

当ポジションは弊社Webサービスのフロントエンド機能設計及び実装を担当します。 サービス毎の開発チームで2週間スプリントのスクラム開発を実施しています。 週次で開発チームミーティングを実施し、実装設計の相談や工数見積もりを行います。 全ての開発コードはレビューと自動テストによって品質を保っています。 また、リファクタリングやフレームワークのバージョンアップも開発フローに組込み、技術的負債を放置しない開発を目指しています。

インターン(Webエンジニア)

業務内容

業務から独立した、調査・研究系のタスクをおまかせしています。コードレビュー、 社内での報告会、 ブログ記事執筆を通して着実にスキルアップしていただくことを目指しています。 (希望があれば、プロダクトの開発業務もおまかせします。)

→
←

お客様のご要望に「Kabuku」はお応えいたします。
ぜひお気軽にご相談ください。

お電話でも受け付けております
03-6380-2750
営業時間:09:30~18:00
※土日祝は除く