kintone設定管理ツールginueメモ

ginueについて

ginueはkintoneのアプリの設定情報を管理するためのツールです。いつも使わせていただいております。ありがとうございます。

詳しくは👆を見てください。

この記事は自分用メモです。

ginueの導入

npmから。

npm i -D ginue

ginueの設定

いろいろ書き方があって迷うので、決定版をここに。
ginueの設定は.ginuerc.jsが書きやすい。これをプロジェクトホームに置く。

.ginuerc.js

module.exports = {
    //ディレクトリの設定
    location: 'kintone',

    //環境は名前をいくつでも設定できる
    env: {
        dev: {
            domain: 'example.cybozu.com',
            username: 'login_name',
            password: 'login_password',
            //basic認証は:でIDとパスワードを連結（kintoneの仕様といっしょ）
            basic: "Administrator:myBasicAuthPassword",
            //アプリはアプリIDの配列で指定可能だが、
            //名前を付けたオブジェクトほうが、出力後の視認性がよい
            app: {
                "customer-master": 2597,
                "support-history": 2598
            }
        },
        stage : {
            domain: 'example.cybozu.com',
            username: 'login_name',
            password: 'login_password',
            basic: "Administrator:myBasicAuthPassword",
            app: {
                "customer-master": 3597,
                "support-history": 3598
            }
        },
        prod : {
            domain: 'example.cybozu.com',
            username: 'login_name',
            password: 'login_password',
            basic: "Administrator:myBasicAuthPassword",
            //ゲストスペースを指定できる
            guest : 5,
            app: {
                "customer-master": 7,
                "support-history": 8
            }
        }
    },
}

この設定での出力結果はこのようになる。

│  
└─kintone
    ├─dev
    │  ├─customer-master
    │  │      アプリ設定
    │  │      
    │  └─support-history
    │          アプリ設定
    │          
    ├─prod
    │  ├─customer-master
    │  │      アプリ設定
    │  │      
    │  └─support-history
    │          アプリ設定
    │          
    └─stage
        ├─customer-master
        │      アプリ設定
        │      
        └─support-history
                アプリ設定

これをdiffツールやGitなどで管理する。

コマンド

データの取得、反映。

# 環境からデータを取得
npx ginue pull 環境名：省略するとすべて

# 環境にデータを反映（リリースはしない）
npx ginue push 環境名：省略するとすべて

よく忘れるコマンド

# 環境の状態をリリースにする（kintoneのアプリを更新ボタン）
npx ginue deploy 環境名：省略するとすべて

まとめ

素晴らしいツールです。ginue pushしない限り安全に利用できます。
設定を取得した後、ぼくはWinMergeで開発と本番の環境の違いを調べています。

この記事は以上です。

---

kintoneのカスタマイズやプラグイン開発・コンサルティングを行っています。