はじめかた
GitHub で Fervio を使いはじめる
GitHub 側で何を押すのか、Fervio が代わりに何を作るのか、プロジェクトや組織が出てこないときにどこを見るのか。最後まで通しておよそ 10 分です。手順 1 から 7 までは順に読んでください。8 と 9 は、困ったときに引く章です。Linear をお使いの場合もほとんど同じで、違うところは必要な場所に書き添えています。
はじめる前に
- GitHub のアカウントと、地図に載せたい課題のあるリポジトリを使う権限。
- Projects v2 のプロジェクト。すでにあるものでも、手順 3 で Fervio に作らせても構いません。旧 Projects には対応していません。Fervio が読むのは Projects v2 の API だけです。
- プロジェクトが組織のものなら、組織の管理者が一度だけ Fervio を承認する必要があります。手順 6 で扱います。プロジェクトが出てこない理由は、たいていこれです。
1. サインインする
fervio.co/app を開いて、入り方を選びます。GitHub の同意画面が一度だけ出て、そのあと Fervio に戻ってきます。
画面には「非公開リポジトリへのフルコントロール」と出ます。これは GitHub 側の文言です。GitHub には「課題だけ」という権限が無いので、非公開リポジトリの課題に触れるには広いほうを求めるしかありません。 Fervio はソースコードを読む API を一度も呼びませんが、それはプログラムの約束であって、 GitHub が止めているわけではありません。権限のページに、何を渡すのか、そのうち実際に使うのはどれか、GitHub 自身が止めてくれる絞りはどれか、を全部書いてあります。
入り方は 3 つあって、渡すものが違います。
| 入り方 | 届く範囲 | こういうときに選ぶ |
|---|---|---|
| 既定 | 公開・非公開の両方 | 課題が非公開リポジトリにある。ふつうはこれです。 |
| 公開リポジトリだけ | 公開リポジトリだけ。GitHub が止めます | 約束ではなく確実な保証がほしいとき。非公開のプロジェクトは開けなくなります。 |
| メールのリンク | 繋ぐまで GitHub には何も届きません | まず中を見てみたいとき。あとから設定で GitHub を繋げば、同じアカウントに着きます。 |
2. 接続を確かめる
サインインするとボードの一覧に着きます。名前の下のメニューから設定を開いて、接続が並んでいることを確かめてください。1 つのアカウントで GitHub と Linear を同時に持てますし、 Linear のワークスペースを複数持つこともできます。
3. 最初のボードを作る
スペースは、繋いだアカウント 1 つぶんのボードを束ねる器です。ボードは、プロジェクト 1 つを写したストーリーマップ 1 枚です。スペースの見出しにある「+ ボード」から始めます。
ウィザードは、この順で訊きます。
- 個人か、組織か。 必要な権限も、物ができる場所も違うので、混ぜずに最初で分けています。
- どう始めるか。 3 通りあります。すぐ下で説明します。
- 新しい課題をどこに作るか。 Projects v2 のプロジェクトは複数のリポジトリにまたがれるので、プロジェクトを選んだだけでは作成先が決まりません。新しいカードを作るリポジトリを選んでください。あとから列ごとに変えることもできます。
- 名前をつける。 選んだものの名前がすでに入っています。直したい人だけ直してください。
どれを選ぶか
| 始め方 | 何が起きるか |
|---|---|
| 新しいプロジェクトを作る | Fervio が Projects v2 のプロジェクトを作り、地図に要る 2 つの項目を足して、空の地図を開きます。 |
| 既にあるプロジェクトを使う | そのプロジェクトをそのまま使います。2 つの項目が無ければ足しますが、それ以外には触れません。 |
| 課題を取り込む | プロジェクトを作ってから、選んだ課題をリポジトリから入れます。まだプロジェクトに載っていない積み残しがあるときに向いています。 |
4. 骨格は Journey と Step の 2 項目で決まる
ストーリーマップは、上段の骨格と、その下に並ぶカードでできています。Fervio はその骨格を、 Projects v2 の単一選択の項目 2 つに持たせます。探し方は名前です。
Journey— 上段の帯。物語の粗い段。Step— 帯の下に並ぶ列。
どの始め方を選んでも、無ければ Fervio が作ります。手で作る必要はありません。ただふつうのプロジェクトの項目にすぎないと分かっていると、後の作業が楽になります。 GitHub の画面で直せますし、ほかの道具からも読めますし、Fervio をやめても項目はそのまま残ります。
Journey と Step の単一選択の項目
Linear の場合は、同じ 2 段がイニシアチブとプロジェクトから来るので、作るものはありません。
5. リリースとスプリントの行は GitHub 側で用意する
地図を横に切る帯は、いま出すリリースか、いま回しているスプリントです。 Fervio はこれを GitHub から読むので、用意するのは GitHub 側です。
- リリースはリポジトリのマイルストーンから来ます。リポジトリの Issues タブで作ります。
- スプリントはプロジェクトの反復 (iteration) の項目から来ます。プロジェクトの項目設定で足せば、Fervio が自動で拾います。
6. 組織のプロジェクトを使うとき
つまずくのはたいていここです。 GitHub は既定で、組織への外部アプリのアクセスを制限しています。しかも承認していない組織は「拒否されました」ではなく、一覧から丸ごと消えます。そのため、承認していないだけなのか、そもそも組織に入っていないのかを、画面から区別できません。
- GitHub で、組織の Settings → Third-party Access → OAuth application policy を開きます。
- Fervio を探して承認します。管理者でなければ承認を申請を押してください。管理者が一度だけ承認する必要があります。
- Fervio に戻ってボード一覧を読み込み直すと、組織が出てきます。
組織のプロジェクトを初めて使うとき、Fervio は「あなたがどの組織に入っているか」を読む許可も GitHub に求めます。これは 2 枚目の、もっと小さい同意画面です。この手順でしか訊かないので、組織のプロジェクトを使わない人には一度も出ません。
承認したのにリポジトリが 0 件のままなら、その組織が IP 許可リストを使っていないか確かめてください。許可リストにアプリが入っていないと、GitHub は組織を見せたまま要求だけを拒みます。そのため「承認したのに空」という見え方になります。
7. ほかの人に入ってもらう
招待ボタンはありません。誰が入れるかを決めるのは GitHub だからです。ボードの URL を渡してください。相手が開いた時点で、Fervio は GitHub に「この人にこのプロジェクトが見えますか」と訊きます。その答えが全部を決めます。
- GitHub で見える → 地図が開きます。
- GitHub で編集できる → 地図も編集できます。
- GitHub で見えない → その人にとって、そのボードは存在しません。
つまり人の出し入れは、いつもどおり GitHub のリポジトリや組織で行います。そちらで外せば、次の要求からこちらでも外れます。Fervio が見せているメンバーの一覧は、ボード一覧に出すための索引であって、権限ではありません。
GitHub のアカウントを持たない人には、ボードのメニューから閲覧専用リンクを発行してください。その URL を持っている人は、サインインせずに読み取り専用のスナップショットを開けます。 URL そのものが合い言葉だと思って扱ってください。リンクは 90 日で切れます。そのボードを編集できる人なら誰でも、出ているリンクを全部無効にできます。
8. 出てこないとき
| 見えている症状 | 理由 | 直し方 |
|---|---|---|
| 組織が一覧に出ない | その組織の外部アプリの方針が、まだ Fervio を承認していません。 | 手順 6 へ。承認するまで一覧に出てきません。 |
| 組織は出るがリポジトリが 0 件 | たいてい IP 許可リストです。 | 管理者に、組織の IP 許可リストの設定を確かめてもらってください。 |
| プロジェクトに項目があるのに地図が空 |
Step がまだどれにも入っていないか、GitHub 側で項目の名前が変わっています。
|
項目の名前が Journey と Step ちょうどであることを確かめて、いくつかの項目に Step を入れてください。
|
| スプリントの行が出ない | プロジェクトに反復の項目がありません。 | プロジェクトの項目設定で足してください (手順 5)。 |
| カードは動くのに保存されない | GitHub 側が読み取りだけで、書き込みの権限がありません。 | プロジェクトへの書き込み権限をもらってください。Fervio は GitHub を写しているので、それ以上は渡せません。 |
| 全部が読み取り専用になっている | 無料プランのボード数の上限を超えています。 | 設定でどれを編集できるままにするか選ぶか、有料プランへ。どちらでも何も消えません。 |
| Linear のボードが開かない | そのボードは、まだ繋いでいないワークスペースのものです。 | 設定でそのワークスペースを繋いでください。同時に複数持てるので、繋ぎ直す必要はありません。 |
| カードが 2,000 枚で止まる | これは規模の上限です。カードを動かしたときに引っかからない速さを保つために決めてあります。 | プロジェクトを絞るか、ボードを 2 つに分けてください。 |
9. やめるとき
ボードを消すと、その並び順・メンバーの一覧・共有のスナップショットが Fervio から消えます。 GitHub にある課題・プロジェクト・マイルストーンには触れません。例外は 1 つだけで、 Fervio のウィザードが作ったプロジェクトは、ボードと一緒に消すことを選べます。選んだときだけ消えます。
まとめて消すなら、設定のいちばん下のアカウントの削除を使ってください。 Fervio は GitHub 側の許可も自分で取り消すので、認可済みアプリの一覧からも消えます。 GitHub → Settings → Applications からご自分で取り消すこともできます。
先にコピーが要るなら、設定のデータの持ち出しで JSON を落とせます。並び順と行の割り当ては、ここにしかありません。
それでも解決しないとき
[email protected] へお書きください。作った本人が読んでいます。手順 8 のどの行がいちばん近いかを書き添えてもらえると、やり取りが短くて済みます。