概要
本ページでは、gitlab web UI の機能をさらっと説明します。
また、gitlab web UI には機能がたくさんあるので、
触っても問題ない機能(ボタン) には (OK印)
触ったら危ない機能(ボタン) には (赤丸)
のマークを付けています。
対象とする読者
- とりあえず gitlab web UI が何なのか知りたい人
- 非開発者で issue の利用や、ファイルを閲覧するのがメインな人
- gitlab web UI の操作に慣れていない人
- 英語を翻訳するのがめんどくさい人(特に自分)
扱わない話題
- 各機能の詳細については扱いません
- gitlab の CUI や API の操作方法については扱いません
環境制約
- gitlab version:今回解説する gitlab の version は 14.4 です
- プロジェクトによっては、今回紹介する機能の一部が、
設定によって非表示となっているものもあります。- 例えば CI/CD は、CI/CD の利用を許可していないと、項目自体が表示されません
gitlab とは?
コードのバージョン管理機能である git のライブラリの一つ。
web UI が存在し、コードの閲覧や編集、管理が可能です、
また、issue というチケットのようなシステムがあり、
チケット管理システムとしても使えます。
※個人的には、Redmine よりも優秀だと思います
余り知られていませんが、実は他にも色々なことができます。
- 自動テスト(CI/CD)の実施
- 短文やファイルの連携用途に
- 各環境への資材のリリース
- 各環境のログの閲覧やアラート管理
- 顧客からの不具合レポートを自動でチケット起票
- 静的な web サーバとして…などなど
gitlab 操作の基本方針
知らない青いボタン、赤いボタン は基本的には押さない。
意味の分からないアイコン も基本的には押さない。
これは大事です。
例えば、下図の右側の青ボタンは押してはダメです(ブランチ作成)。
左は分かりにくいですが、赤文字のボタンなので押さない様に(ブランチ自動削除)。
また、下図のケースではゴミ箱のアイコンだけがあり、
ぱっと見は安全そうですが、中身はブランチの削除なので押したら危険です。
(左はダウンロードボタンなので安全)
仮に押してしまっても、
下図のように確認のウィンドウが出ますので、
ここでは Cancel を押しましょう。
右側のボタンは赤いので押さない様に!
とりあえず覚えておきたい用語
プロジェクト(レポジトリ)
プロジェクトとは、gitlab におけるメインページの呼称です。
ツール毎、アプリケーション毎、など、
基本的には開発者が機能毎にプロジェクトを作りますが、
運用者が "マニュアル管理"、"障害管理" など
用途毎にプロジェクトを作ることもあります。
サイドバー
gitlab web UI のプロジェクトを開くと
左側に下図の様なメニューが出てくると思います。
これをサイドバーと呼び、
gitlab の作業は基本、ここから行います。
逆引き
※今後追加予定
とりあえず機能をざっと把握したい
gitlab のメイン機能は、
UI の左にあるサイドバーにほぼ集約されています。
なので、ここの機能を覚えれば、
gitlab の大体の機能はざっと把握できます。
(あくまで "ざっと" です)
サイドバーの機能については、別ページにまとめていますので、
そちらを参照してください。
前編
後編
課題管理をしたい
gitlab の課題管理(チケット管理)は、
issue という機能を用いて行います。
Redmine などのチケット管理システムと似ており、
無駄な機能もなく、ほぼ遜色なく使えます。
また、gitlab 上のファイルや、
開発者の更新とも連動できるので、
テスト実施者が開発者に不具合報告する際にも便利です。
issue ページにはサイドバーから遷移できます。
簡単な説明は以下に記載しています。
ファイルの内容を確認したい
gitlab の本来の目的はファイル管理(資材管理)です。
なので、基本的な gitlab のプロジェクトには、
開発者や運用者が格納したファイルがたくさん格納されています。
閲覧するだけなら無害なので、
開発者でなくてもファイルの確認やダウンロードができます。
ファイルの閲覧は、サイドバーの Repository > Files から遷移します。
簡単な説明は以下を参照ください。
プロジェクトの使い方や注意事項を書いておきたい
gitlab のプロジェクトを最初に開くと、
基本的にはファイルの一覧が表示されます。
そのページをスクロールしていくと、
下の方に READEME と呼ばれるプロジェクトの説明が表示されます。
このファイルを編集すると、
プロジェクトに関する説明などを書いておけます。
詳細な作り方は以下を参照してください。
長いログやファイルを他のメンバーに共有したい
仕事をしていて、
端末の作業ログや、そこまで大きくないテキストファイルなどを
他のメンバーに共有したい、と思う機会は多いと思います。
gitlab の snippets という機能を使うと、
短文の連携や、小さいファイルの添付(連携)ができます。
詳しい使い方は以下を参照してください。
wiki を書きたい
社内の wiki というと、CF や pukiwiki などを思い浮かべる方も多いかと思いますが、
gitlab でも wiki は書けます。
wiki の作成は、サイドバーの wiki から行います。
issue で一部の記号が勝手に変換されてしまう
例えばこんな内容を書きたい場合。
- "mode": "0644",
+ "mode": "0755",
そのまま書いてしまうと
- "mode": "0644",
- "mode": "0755",
こんな感じで +
や -
が箇条書きに変換されてしまいます。
対策としては、マークダウン記法の
インラインコードかコードブロックを使います。
詳しくは以下を参照してください。