概要
本ページでは、gitlab web UI の機能のうち、
知っておくと便利な機能をさらっと説明します。
メインページは以下になります。
知っておくと便利な機能
README.md
Files 直下に置かれるファイル。
プロジェクトを開いた際に、一番最初に表示される内容になるので、
プロジェクトの概要やルールを書いておくと良いでしょう。
※記述方法は issue や wiki と同じマークダウンです
作り方
プロジェクトを作る際に、
initialize repository with a README のチェックを入れるだけ。
※もし、チェックを外してプロジェクトを作ってしまった場合。
一度プロジェクトを git clone し、
READEME.md を作成して git push する必要があります。
操作が分からない場合は、有識者に依頼しましょう。
snippets
snippet と呼ばれる短文を書ける機能です。
リンク知っていれば gitlab にログインできるユーザなら誰でも見られるので、
ちょっとした情報の連携にも使えます。
活用例
- リリース作業時の差分を貼りつけて確認してもらうとき
- あまり大きくないファイルを共有したいとき
- Description にファイルを添付すれば OK
作成方法
gitlab 上部のツールバーの ＋ マークから、New snippet を開きます。
Title に分かりやすい名前を付け、
Files（下図の赤枠内）に書きたい事を書きます。
公開範囲（Visibility level）を選択し、
Create snippet を押して作成します。
公開範囲は、Internal（gitlab にログインできるユーザのみ見られる）にするのが無難です
※なお、Public だとログイン不要で見られますが、
gitlab 自体に特に閲覧制限をかけていない場合、
社外からも見えてしまうので注意です！
※private は snippet の一覧に表示されないだけで、
URL を知っていれば見られます。
なので、個人間のファイルのやりとりなどで使えそうです。
integration
外部サービスに gitlab の変更を通知する機能です。
Settings > integration から設定できます。
gitlab の通知は、デフォルトで gitlab アカウントのメールアドレスに対して届きますが、
昨今のテレワーク続きにより、メールよりも Teams などのツールを利用する方が多いので、
issue の更新通知漏れを防ぎたい場合、などに有効です。
ただし、メンションされていなくても通知が飛ぶので、
ノイズになる可能性はあります。
インラインコード と コードブロック
gitlab の issue などでは、マークダウン（Markdown）と呼ばれる特殊な記法があります。
そのマークダウンの中に、
インラインコード (Inline code) と
コードブロック (Code block) というものがあります。
これは何？
マークダウンにおいて、文章整形の記号を無視してくれる機能です。
本来はその名の通り コード（cd /var/xxx）を表現するために使いますが、
運用現場などでは URL や 作業ログ、長い会話の引用 にも使います。
使用ケース
マークダウンでは、一部の記号を文中の特定の位置や、
特定の個数使用すると、文章を自動的に変換※してくれます。
※箇条書きや太文字に変換する など
しかし、状況によっては意図しない変換が行われることもあります。
例えばこんな内容を書きたい場合。
- "mode": "0644",
+ "mode": "0755",
そのまま書いてしまうと
- "mode": "0644",
- "mode": "0755",
こんな感じで + や - が箇条書きに変換されてしまいます。
こんな時にインラインコードなどを使うと、
+ や - など、どんな記号でも
自動変換されずに記述することができます。
また、URL についても自動リンクされなくなるので、
ログなどを貼った際に、意図しないリンク（ツールなどのインストール元 URL）が有効化されることを防げます。
https://qiita.com/drafts/6f61fe5dd47296c4071a
使い方
インラインコード
自動変換されたくない文字列を `(バッククォート) で括ります。
主に、URL や コマンド など、単一行の文章で使います。
例：
`cd /var/log/maillog; pwd`
↓
cd /var/log/maillog; pwd
コードブロック
自動変換されたくない文字列を ```（トリプルバッククォート）で括ります。
主に、複数行に渡る長文（ログや操作記録、過去の長い会話）などで使います。
TASK [change mode] *******************************
Monday xxx
--- before
+++ after
- "mode": "0644",
+ "mode": "0755",