Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 3.57 KB

README_CI.md

File metadata and controls

76 lines (54 loc) · 3.57 KB

継続的インテグレーション(CI)の手引き

概要

RCCでは,総会文書のビルドをCIツールを用いて自動化しています. ビルド自動化のメリットは,ビルドの手間を減らすことができるということに尽きるでしょう.

現在の設定では,ブランチへのファイル変更があった場合、すぐに文章校正とビルドテストを行っています. ビルドに関しては,Dockerコンテナのイメージであるalpine上にLatex環境を組み込んだ環境で行い, 文章校正は,文章校正ツールであるunagiを利用しています.

この文書では,GitLab CIを用いたCIの設定方法について解説します.

GitLab CIを用いたCI

GitLab CIとは

GitLabに備わっている継続的インテグレーションサービスです. ビルド手順やデプロイ手順を書いた設定ファイル(.gitlab-ci.yml)を用意するだけで利用することができます. 過去に使用されていた,WerckerやCircleCIなどのCIサービスは連携設定が必要でしたが, GitLab CIではその設定が不要なため,気軽に利用できます.

作業手順

ビルドの設定に必要な手順を最初から順に示します. 現在,総会文章リポジトリでは,文章校正ツールであるunagi以外で特殊な設定を行う必要はありません.

  1. .gitlab-ci.yml.sampleを.gitlab-ci.ymlに名前を変更します. 総会文章テンプレートの手順でリポジトリを初期化した場合はすでに完了していると思われます.
  2. GitLabのシス管アカウント(ritscc)でログインし,ユーザー設定 - アクセストークンから
  • api
  • r/w repository の権限を付与したトークンを発行してください.
  1. プロジェクトの設定にあるCI/CD - Variablesから
Key : GITLAB_UNAGI_TOKEN
Value : 発行したトークン

Key : AUTHOR_ID
Value : ritsccアカウントのアカウントID

を設定してください。

  1. 使用するunagiのコミットハッシュを設定(optional) unagitools/clone_unagi.shによってcloneされます。
    CIでunagiのmaster最新コミット以外の状態を使用したい場合は、手順2と同様に
Key : UNAGI\_COMMIT
Value : 対象コミットハッシュ(例:f6e2a1b2)

を設定してください。masterの最新コミットを使用する場合はこの手順を読み飛ばせます。

  1. Complete!

なお,最新のSetup方法に関しては,必ず文章校正ツールであるunagiの(README)[https://gitlab.com/ritscc/soukai/unagi/-/blob/master/README.md]を確認し, その手順に進めることをおすすめします.

カスタマイズ

カスタマイズを行ってくれる人を募集しています.総会文書の執筆をよりよくするようなソリューションを待っています.

本リポジトリの.gitlab-ci.ymlには,Dockerコンテナ内で行なわれるビルドとデプロイの手順が記述されています. このファイルを変更することで,ビルドの動作やデプロイの方法を変更することが可能です.

GitLab CIの仕様については,GitLab CI/CDを参照してください.