アトラシアン製品の拡張機能開発クラウドプラットフォーム Forgeの環境構築方法

みなさんこんにちは。
先日、Forgeのworkshopを開催したのですが、環境構築でうまくいかないという方がいらっしゃったので、日本語で解説記事を書いてみました。もし、アトラシアン製品の拡張機能開発やカスタマイズに興味がある方は、Forgeを使ってみることをお勧めします。面白いほど簡単に拡張機能開発ができちゃいます。
Forgeって何？という方はこちらに解説動画を載せていますので、ぜひ見てみてください。

ちなみに、このnoteは主にコミュニティ関連の情報を発信していますが、時々コミュニティに皆様に興味を持っていただけそうな技術的な記事も出していきたいと思います。
興味を持っていただけたら、さらに深掘りしてブログなど書いていただけたら幸いです。

ということで、それでは環境構築手順スタートです。

Node.jsのインストール

MacOS

MacOSではNode Version Manager(nvm)を使用してNode.jsをインストールします。インストールにあたってはターミナルを使用します。

事前にこちらのコマンドをターミナルで実行しておいてください。nvmを実行する際の環境変数を書き込む対象ファイルを作成します。

touch ~/.zshrc

nvmのインストール方法はこちらを参考にしてください。

こちらの”Install & Update Script”にあるcurlもしくはwgetで始まる１行をコピーしてターミナルから実行してインストールを行います。どちらか一方を実行すれば大丈夫です。

nvmのインストールが完了したら次の二つのコマンドをターミナルで実行します。

nvm install --lts
nvm use --lts

このコマンド実行で”zsh: command not found: nvm”と表示される場合は、下記のコマンドを実行してください。

export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm

最後に次のコマンドをターミナルで実行してバージョン番号が表示されれば、インストールが成功しています。

node --version

Windows

Windowsの場合はこちらのプレビルドのインストーラーを使用するのが簡単です。

Node.js — Download Node.js®

Forge CLIのインストール

npmを使用してForge CLIのインストールを行います。

インストールを行うためには次のコマンドを実行します。

npm install -g @forge/cli

インストールが完了したら次のコマンドを実行して、バージョン番号が表示されればインストールは成功しています。

forge --version

もし、表示されない場合は、Node.jsのインストールからやり直してください。

Forgeへのログイン

Atlassian API tokenの取得

Forge CLIを使用するにはAtlassian API tokenを使ってForge Platformにログインする必要があります。まずは、こちらのページにアクセスしてAtlassian API tokenを取得します。

https://id.atlassian.com/manage/api-tokens

このページの”APIトークンを作成する”をクリックします。トークンに設定するラベルの名称を聞かれるので、わかりやすい名称を設定してください。

名称をつけたら”作成”をクリックしてください。その後、トークンのコピー画面が表示されます。このトークンはこのタイミングでしかコピーできないので、必ずコピーしてどこかにメモしておいてください。ただし、このトークンは漏洩する様な場所には保管しない様にしてください。

保管が完了したら”終了”をクリックしてダイアログを閉じてください。

Forgeへのログイン

次のコマンドを実行してForge Platformへのログインを行います。

forge login

コマンドを実行するとemailアドレスを聞かれるので、ログインするアトラシアン アカウントのemailアドレスを入力してEnterを押してください。

? Enter your email:

続いて下記の様なメッセージでAPIトークンの入力を求められるので、先ほど取得したAPIトークンをペーストしてEnterを押してください。

? Enter your Atlassian API token: [hidden]

正しく入力されていれば次の様に表示され、ログインが完了します。

Logged in as (あなたのお名前)

APIトークンの取得直後にログインを行なった場合、APIトークンが有効化されておらず失敗する場合があります。1分ほど時間を置いてから再度ログインをしてみてください。

Developer サイトのセットアップ

作成したアプリをインストールしてテストするためのサイトを登録します。サイトのサブドメインを指定して作成してください。こちらのサイトはテスト用として新規に作成するサイトになります。普段使用されているものとは異なるので、注意してください。

http://go.atlassian.com/cloud-dev

こちらのサイトでは開発に必要な権限を持った状態でのサイトを登録できます。ただし、開発およびテスト以外の目的ではご利用いただけません。

これでForgeの開発環境は整いました。ここからはForgeを使った開発を行なっていくのですが、開発の手順に関してはまた別途記事を書いてみたいと思います。お楽しみに！

---

追記)続きを書きました。