2021年3月2日火曜日

Gitlab の Snippets 機能を使ったみた

概要

Gitlab の Snippets 機能はあるファイルの内容を Gitlab でホスティングして HTML に組み込んだりダウンロードしたりできる機能です
今回はスニペットを新規に作成して HTML に組み込んでみました

環境

  • Gitlab-ee 13.8.4

スニペットの作成

まずはスニペットを作成しましょう
左メニューの「Snippets」から新規作成します
今回は Ruby のサンプルコードを作成しました
Title や Description は自由に設定しましょう
ファイル名の拡張子に .rb を指定するとスニペットの内容を Ruby コードとして認識してくれてハイライトなどしてくれます

そして下にある公開情報を設定します
今回はスニペットの HTML 組み込みを試すので Public を指定します

プロジェクトの公開設定

スニペットを Public だけにしただけでは組み込みスニペットは使えません
プロジェクト自体の公開設定も Public にしましょう
左メニューの「Setting」->「General」->「Visibility, project features, permissions」から設定します

組み込み用 HTML の取得

あとは組み込むための HTML を取得します
作成したスニペットを見ると「Embed」ボタンがあるのでそこから取得します

動作確認用の HTML ファイルの作成

何でも OK です
先程取得した組み込み用 HTML を記載しましょう

<html>
<head>
</head>
<body>
  <script src="https://gitlab.example.com/root/bb/-/snippets/2.js"></script>
</body>
</html>

あとは nginx などで適当に確認すると以下のように Gitlab に作成した Snippets の内容が確認できると思います

スニペットのダウンロード

スニペットのページに raw の URL とダウンロード用の URL が取得できるのでコピーして使いましょう

ダウンロードの URL は試した見た感じ txt ファイルとして保存されました
もしかするとブラウザの挙動にもよるかなと思います

最後に

イメージ的には Github の Pages の機能に近いと思います
Gitlab にも拡張機能として Pages がありますが Snippets はデフォルトで使える機能になります

参考サイト

0 件のコメント:

コメントを投稿