GitLabファイル共有入門 (Webブラウザだけで使うGitLab)

「Gitってなに？」「Gitって難しそう」と思われている方も多いと思います。 ここでは、Webブラウザだけで、GitLab(ネットワークサービスシステムの「Gitリポジトリサービス」)を使い、ファイル共有や共同での文書作成、バージョン管理を行う方法について説明します。

• Gitリポジトリサービスへのログイン
  • Authinticator の準備
  • 2要素認証端末の登録
  • Gitリポジトリへのログイン
    • 初回ログイン時に認証端末を登録
  • ワンタイムコードによるログイン
• 利用者環境の設定(言語設定)

ここまでが準備作業となります。

• プロジェクトの作成
  • プロジェクト名、プロジェクトURL、可視(公開)レベル
• ファイルのアップロード
• ファイルの更新(置き換え)
• 更新履歴(コミット)
• 過去のファイルの取り出し
• ディレクトリ作成
• Open Web IDE
  • テキストファイル編集
  • ファイル名変更、ファイル移動、削除
• ファイルのダウンロード
• ファイル共有メンバーの追加
  • プロジェクトへのメンバー追加
  • ユーザ権限について
• 注意

セキュリティ強化のため、Gitリポジトリサービスへのログインは、2要素認証を行っており、 スマホアプリの「モバイル・オーセンティケーター」が必要です。

お使いのスマホやタブレット端末(Andoroid, iOS, iPadOS)に、モバイル・オーセンティケーターを インストールしてください。 (Google Play, App Storeから検索し、インストールしてください。)

以下のアプリは、動作を確認しています。(どれか1つを選択)

• Google Authenticator
• FreeOTP Authinticator
• Microsoft Authenticator

ログイン(認証)に使用するオーセンティケータを登録する必要があります。

Gitリポジトリサービスとファイル共有システムは、共通の認証を行っています。

2要素認証端末の登録方法については、ファイル共有システム利用の流れ https://ml-wiki.sys.affrc.go.jp/help/nextcloud/usage も 参照してください。

1. ネットワークサービスシステム https://nss.sys.affrc.go.jp の画面左側「Gitリポジトリサービス」を選択します。
   

直接「Gitリポジトリサービス」 https://nssgl.sys.affrc.go.jp に、アクセスすることも可能です。

1. AFFRITアカウントの「アカウント名、パスワード」を入力し、「ログイン」をクリックします。
   

1. 初回ログイン時は、「モバイル・オーセンティケーターのセットアップ」画面が表示されます。
   

1. スマホ、タブレットのAuthenticatorアプリを起動して、QRコードを読み取ります。
   

1. アプリに表示された「ワンタイムコード(6桁の数字)」と「デバイス名」を入力し、「送信」をクリックします。
   

• アプリ画面の数字は、見やすいように3桁ごとの区切りがありますが、6桁の数字を続けて入力してください。

1. GitLabリポジトリサービス https://nssgl.sys.affrc.go.jp へのログイン
   

1. AFFRITの「アカウント名、パスワード」を入力
   

1. 2回目以降は、ユーザ名、パスワード認証後に、ワンタイムコードの入力画面が表示されます。
   

1. スマホのアプリを起動して、表示されている6桁の数字を入力してログインします。
   • 数字は有効時間(30秒)ごとに更新されますが、ギリギリの場合は更新を待ってから更新後の数字を入力してください。

初めてログインしたときは、英語表示となっています。言語設定を日本語に変更します。

1. 画面右上のユーザアイコンをクリックし、メニューから「Preferences」を選択します。
   

1. 設定画面をスクロールして、「Localization」の「Langage」から「Japanese-日本語」を設定し、「Save Changes」ボタンで設定を保存します。
   

目的ごとにプロジェクトを作成します。

1. 画面右側の「新規プロジェクト」をクリックします。
   

1. 通常は「Create blank project」を選択して、新規プロジェクトを作成します。
   

1. プロジェクトの作成画面が表示されます。
   

1. 「プロジェクト名」を入力します。(日本語も設定可能)
2. 「プロジェクトのURL」を入力します。
   • 個人の場合は、ユーザIDを指定し、「Project slug」にはディレクトリ名を指定します。
     

(ディレクトリ名は、半角英数字が無難です。)

1. 「可視レベル」(公開範囲)を選択します。
   • 通常は「プライベート」を指定します。プロジェクトにメンバーを追加すれば、メンバーだけに共有されます。
   • 「内部」は、Gitリポジトリサービスにログイン可能なユーザ、全てに公開されます。
2. 「プロジェクト作成」ボタンをクリックして、プロジェクトを作成します。
   

パソコンなどで作成したファイルをアップロードします。

1. 画面中程の「+v」をクリックしメニューを表示し、「ファイルをアップロード」を選択します。
   

1. [Drop or upload File to atach] をクリックして、パソコンのファイルを選択 (エクスプローラーや Finder が表示されます) します。 (ファイルをドラッグアンドドロップも可能)
   

1. 「コミットメッセージ」を入力します。
   

• コミットメッセージは、後で履歴を見て作業内容がわかるよう簡潔に記述します。
• 複数行記述可能ですが、履歴(コミット)には、最初の1行が表示されます。

1. 「ターゲットブランチ」は、[main]としてください。(ブランチの利用は、ここでは説明しません)
2. 「ファイルをアップロード」ボタンをクリックして、アップロードを実行します。
   

パソコンでファイルを修正した場合は、Gitリポジトリのファイルを最新状態にします。 ファイルの更新は、同じファイル名でファイルを置き換えます。Gitリポジトリはバージョン管理されているため「置き換え」で上書きしても、古いバージョンのファイルを取り出すことができます。 古いファイルを参照する際に見つけやすい「コミットメッセージ」を、入力しておくと良いでしょう。

1. リポジトリのファイルリストから、更新するファイルを選択します。
   

1. ファイル名の右側の「置き換え」ボタンをクリックします。
   

1. [Drop or upload File to atach]をクリックして、パソコンのファイル(同じファイル名)を選択します。
   

1. コミットメッセージを入力して、「Replace file」をクリックしてアップロードします。
   

Gitは、コミットごとに更新履歴(ログ)とファイルの状態を保存しています。

1. 左側のサイドバー(メニュー)から、「リポジトリ」「コミット」を選択すると、これまでのコミットメッセージ、ユーザ名、日時などが表示されます。
   

1. コミットメッセージの部分をクリックすると、当該コミットとその前のコミットからの差分(更新されたファイルやファイルの更新部分(テキストファイルの場合))が表示されます。
   

• Word文書やPDFファイルなどは、変更されたファイルのファイル名が表示されます。
• テキストファイルは、新旧の変更箇所も表示されます。(Gitは、プログラム開発のバージョン管理ツールです。)

誤って必要な箇所を削除してしまったなど、過去のファイルを参照したい場合は、更新履歴を遡りファイルを取り出すことができます。

1. サイドバーの「コミット」をクリックして履歴を表示します。
2. コミットメッセージの右端のフォルダアイコンをクリックします。
   

1. コミットされた時点のファイルが表示されます。
   

1. テキストファイルの場合、更新前の内容に戻っていることが確認できます。
   

• Word文書などは、ファイル名右端のダウンロードアイコンをクリックして、ファイルをダウンロードして内容を確認してください。

1. ファイル表示を最新のものに変更するには、「ブランチ・タグ切り替え」で「main」に戻すか、サイドバーの「G」アイコンをクリックして、プロジェクトのトップページに戻ってください。
   

ファイルを格納するディレクトリ(フォルダ)を作成することができます。

1. 画面中程の「+v」ボタンをクリックしてメニュウーを表示し、「新規ディレクトリ」を選択します。
   

1. 「ディレクトリ名」「コミットメッセージ」を入力して、「ディレクトリ作成」ボタンをクリックします。
   

1. 作成したディレクトリに移動してファイルが表示されます。 ( .gitkeep ファイルは、空のディレクトリを保持するために作成されます。)
   

GitLabには、簡易的な開発環境「Web IDE」(Open Web IDE)機能が備わっています。
IDEとは、統合開発環境(Integrated Development Environment)というプログラム作成を支援する機能です。

ブラウザを使ってファイル(テキストファイル)を編集したり、ファイル名の変更、削除などの機能があります。 GitLabでは、テキストファイルで記述する軽量マークアップ言語(Wikiでも使用できる markdown や asciidoc 形式)のプレビューも可能です。

1. Web IDEモードへの切り替えは、ファイル一覧表示の場合、右上の「Web IDE」ボタンをクリックします。
   

ファイルを選択している場合は、ファイル名右側の「Open Web IDE」をクリックします。 (「編集」になっている場合は、「v」アイコンから「Open Web IDE」を選択します。)

1. Web IDEの画面に切り替わります。
   

1. Web IDEの左側、ファイルリストからテキストファイルを選択すると、ファイルの内容が表示され、編集可能となります。
   

ファイルが変更されるとファイル名右側のアイコンがオレンジ色になり、左下に「Create commit…」ボタンが青色に変わります。

1. 編集が完了したら、「Create commit…」ボタンをクリックして保存とコミット(Gitの履歴、状態保存)します。
   

• テキストの変更箇所が表示されます。
• このまま保存する場合は、「コミットメッセージ」を入力します。
• ◎ Commit to main branch を選択してください。 (「新しいブランチを作成」は選択しません。ブランチの取り扱いは、ここでは説明しません。)
• 編集内容を保存したくない場合は、「変更を破棄する」 をクリックします。

1. 左側のファイル名にマウスカーソルをフォーカスすると、右側に「︙」メニューボタンが表示されます。
   

メニューから「Rename/Move」を選択して、ファイル名変更やファイルの移動を行うことができます。

1. ファイル名を変更します。ファイルを移動する場合は、移動先のディレクトリ名を含めて( / 区切り)ファイル名を指定します。
   

1. ファイル名変更(移動)をコミットしてGitに履歴と状態を保存します。
   

1. 複数のファイル名変更(移動)を実行した後でコミットすることも可能です。
   

1. ファイルが「documents」ディレクトリに移動しています。
   

ファイルを変更する場合、管理している最新のファイルを取得する必要があります。
プロジェクトで管理しているファイルをまとめてダウンロードすることができます。

1. プロジェクトのトップページ(ファイルリストが表示されている画面)から、右上のダウンロードアイコンをクリックし、 「ソースコードをダウンロード」で、ダウンロードファイルの形式を選択します。
   

(通常は、「zip」を選択します。)

1. ダウンロードした zip ファイルを保存します。保存した zip ファイルを展開してファイルを開きます。
   

• 個々のファイルをダウンロードすることも可能です。
• 特定のバージョンのファイルを一括でダウンロードすることも可能です。

ファイルを他のユーザと共有したり、複数メンバーでファイルを更新する場合には、メンバーを追加してアクセス権限を設定します。
個人のプロジェクトでも、メンバーを追加することでファイル共有が可能です。
追加するメンバーは、「Gitリポジトリサービス」にログインする必要がありますので、この文書の「準備作業」までを実行してください。

1. 左側メニューの「プロジェクト情報」にマウスをフォーカスしてサブメニューを表示し、「メンバー」を選択します。
   

1. 登録されているメンバーリストが表示されますので、右上の「メンバーを招待」ボタンをクリックします。
   

1. 「Username or email address」欄に、追加するメンバーのAFFRITアカウント名を入力します。
   

メンバーの候補リストが表示されますので、メンバーを選択します。(複数の指定が可能です。) 追加するメンバーが準備作業まで実行していない場合は、メンバーの招待ができません。
「Select a role」 で、メンバーの権限を設定します。 ファイルの編集や追加を行う場合は、 「Developper」 以上の権限が必要です。

1. 招待したユーザがプロジェクトメンバーに表示されます。また、権限の変更や削除も可能です。
   

• Guest 見るだけの権限、ダウンロード不可、コメントは可能
• Reporter ダウンロード可能、ファイル共有のみ、ファイルの変更、アップロードは不可
• Developer ファイルの変更、アップロードが可能(共同で編集などを行う場合)
• Maintainer 全般的な管理権限が付与される、Ownerの補助者

共同でファイルの変更を行う場合、競合(変更を反映する前に他者が別バージョンで変更してしまうこと)が発生します。

• 競合(コンフリクト)が発生するとファイルが上書きされ、変更内容が無効になったり、別バージョンの変更に置き換わってしまいます。
• Git本来の使い方であれば、競合の検知や上書きの防止、解消方法などの機能を備えていますが、 ここで紹介した方法(Webだけでファイルを更新)では、競合の検知や上書きを防止することができません。
  

• 複数メンバーで作業する場合は、常に最新のファイルをGitLabに保存し、ファイルを変更する場合は、 最新のファイルを取得した上で、他のメンバーが変更しないようにする必要があります。

コミットメッセージ

• Gitでは、ファイルのバージョン管理を行うため、ファイルを変更する度に「コミットメッセージ」の入力、 「コミット」を実行します。
• いつ、誰が、どのような変更を行ったかを記録することで、修正の目的と修正箇所の確認が可能となります。
• 修正前のバージョンに戻す場合にも、どのバージョンかを確認する上で「コミットメッセージ」が手がかりになります。

Gitの利用について(参考)

• GitLab入門 : https://itcweb.cc.affrc.go.jp/affrit/documents/guide/gitlab/start

参考文献

1. サル先生のGit入門, 株式会社ヌーラボ, https://backlog.com/ja/git-tutorial/ (参照 2021-03-09)
2. サルでもわかるGit入門, 大串 肇 (著), アクツ ユミ (著), 一戸 健宏 (著), 兼清 慮子 (著), 齋木 弘樹 (著), 清野 奨 (著), 福嶌 隆浩 (著), 株式会社ヌーラボ (著), インプレス, 2018-09-25, ISBN-13 978-4295004837
3. GitLab実践ガイド, 北山 晋吾 (著), インプレス, 2018-02-01, ISBN-13 978-4295003038
4. Gitが、おもしろいほどわかる基本の使い方33 改訂新版, 大串 肇 (著), 久保 靖資 (著), 豊沢 泰尚 (著), エムディエヌコーポレーション, 2019-06-28, ISBN-13 978-4844368687
5. いちばんやさしい Git 入門教室, 大澤 文孝 (著), ソーテック社, 2019-08-25, ISBN-13 978-4800712462
6. 【絶対理解できる】Gitとは？特徴やできることまとめ！, 兵政和, https://www.sejuku.net/blog/5756 (参照 2021-03-09)
7. Pro Git, Scott Shacon, Ben Straub, 高木正弘(訳), Yusuke Sato(訳), 2nd Edition (2014), https://git-scm.com/book/ja/v2 (参照 2021-03-15), https://progit-ja.github.io (Pro Git 日本語版電子書籍公開サイト 参照 2021-03-15), License CC BY-NC-SA 3.0