garoon-plugin-uploader

目次

garoon-plugin-uploaderとは

garoon-plugin-uploaderは、プラグインファイルをGaroonに追加できるCLIツールです。
npmパッケージとして提供されているため、Windows/macOS/Linux環境で利用できます。

GitHub

https://github.com/garoon/plugin-uploader (External link)

ライセンス

MITライセンス (External link)

ドキュメント

https://github.com/garoon/plugin-uploader/blob/main/README.md (External link)

導入方法

下準備

garoon-plugin-uploaderを実行するには、Node.jsとパッケージ管理ツールのnpmが必要です。
Node.jsをインストールすると、npmは自動でインストールされます。

  1. Node.js公式サイト (External link) からインストーラーをダウンロードします。
    必要なNode.jsのバージョンは、 package.json (External link) のenginesプロパティの値を確認します。
    たとえば次の記載の場合、Node.jsのパージョン14以上が必要です。

    1
    2
    3
    
    "engines": {
        "node": ">=14"
    },
  2. ダウンロードしたインストーラーを実行し、画面にしたがってセットアップします。

必要なパッケージのインストール

garoon-plugin-uploaderをインストールします。
ここでは、例としてgaroon-plugin-uploaderをグローバルインストールする手順を説明します。

1
npm install -g @garoon/plugin-uploader

garoon-plugin-uploaderのバージョンを確認する

garoon-plugin-uploaderのバージョンを表示して、garoon-plugin-uploaderを実行できるかを確認します。

1
2
3
garoon-plugin-uploader --version

1.0.1 # バージョン番号

操作方法

プラグインをアップロードする

Garoonにプラグインをアップロードするには、--plugin-pathにプラグインファイルを指定します。

  1. アップロードするプラグインファイルを準備する。
    Garoonに追加するプラグインのzipファイルをあらかじめ準備します。

  2. Garoonにプラグインファイルを追加する。
    次のコマンドで、Garoonにプラグインファイルを追加します。
    プラグインをGaroonに追加するにはGaroonの システム管理者 (External link) の権限が必要です。

    1
    2
    
    garoon-plugin-uploader --base-url https://sample.cybozu.com --usernameログイン名 --passwordパスワード \
      --plugin-pathプラグインファイルのパス

    環境に合わせて、次の値を変更してください。

    • sample.cybozu.com:適用するGaroonのドメイン名
    • ログイン名:Garoonのログイン名
    • パスワード:Garoonのログインパスワード
    • プラグインファイルのパス:zipファイルを配置している場所への相対パス

    実行例

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    
    garoon-plugin-uploader --base-url https://sample.cybozu.com --username yamada_taro --password Dj7m4hNL \
      --plugin-path ~/Downloads/create-company-portal-plugin-v1.0.0.zip
    
    Open https://sample.cybozu.com/login?saml=off
    Trying to login.....
    Success Login!
    Navigate to https://sample.cybozu.com/g/system/plugin/settings.csp
    Start uploading file...........
    End uploading file.
    Waiting for reading file...........
    Success submitting file!
  3. Garoonにプラグインが追加されているか確認する。
    Garoonシステム管理画面より プラグインの設定 (External link) を開き、プラグインが追加されているか確認します。

プラグインを更新する

Garoonにすでに追加しているプラグインを更新するには、適用するプラグインファイルのパスと--plugin-idにプラグインIDを指定します。
--plugin-idを指定しない場合、新しいプラグインとして追加されます。

  1. 更新するプラグインのzipファイルを準備する。

  2. 更新するプラグインのプラグインIDを調べる。
    プラグインIDは プラグインの詳細画面 (External link) のURL内で確認します。
    次のようなURLの場合、プラグインIDは「1」です。

    1
    
    https://sample.cybozu.com/g/system/plugin/view.csp?id=1
  3. プラグインを更新する。
    次のコマンドで、Garoonに追加されているプラグインを更新します。
    プラグインを更新するには、Garoonの システム管理者 (External link) の権限が必要です。

    1
    2
    
    garoon-plugin-uploader --base-url https://sample.cybozu.com --usernameログイン名 --passwordパスワード \
      --plugin-pathプラグインファイルのパス --plugin-idプラグインID

    環境に合わせて次の値を変更してください。

    • sample.cybozu.com:適用するGaroonのドメイン名
    • ログイン名:Garoonのログイン名
    • パスワード:Garoonのログインパスワード
    • プラグインファイルのパス:zipファイルを配置している場所への相対パス
    • プラグインID:更新するプラグインのプラグインID

    実行例

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    
    garoon-plugin-uploader --base-url https://sample.cybozu.com --username yamada_taro --password Dj7m4hNL \
      --plugin-path ~/Downloads/sample-plugin-v2.0.0.zip --plugin-id 1
    
    Open https://sample.cybozu.com/login?saml=off 
    Trying to login..... 
    Success Login! 
    Navigate to https://sample.cybozu.com/g/system/plugin/view.csp?id=1 
    Start uploading file........... 
    End uploading file. 
    Waiting for reading file........... 
    Success submitting file!
  4. プラグインが更新されているか確認する。
    Garoonシステム管理画面より該当するプラグインの プラグインの詳細 (External link) を開き、プラグインが更新されているか確認します。

    コマンド実行前(適用しているプラグインのバージョンが「ver.1.0.0」)

    コマンド実行後(適用しているプラグインのバージョンが「ver.2.0.0」)

制限事項

更新履歴

garoon-plugin-uploaderの最新の更新内容は、 Releases (External link) を確認してください。

  • 2022年10月11日:記事を公開しました。
information

この記事の内容は、2022年10月版Garoonおよび @garoon/plugin-uploader v1.0.1で動作を確認しています。