Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 3.06 KB

README_CI.md

File metadata and controls

54 lines (40 loc) · 3.06 KB

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

概要

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

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

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

GitHub Actionsを用いたCI

GitHub Actionsとは

GitHub上のリポジトリやイシューに対するさまざまな操作をトリガーとしてあらかじめ定義しておいた処理を実行できる機能です. 過去に使用されていた,WerckerやCircleCIなどのCIサービスは連携設定が必要でしたが, GitHub Actionsではそういった設定なしに,GitHubだけでCI機能を実現できるため,気軽に利用できます.

作業手順

ビルドの設定に必要な手順を最初から順に示します.

  1. .github.sampleを.githubに名前を変更します. 総会文章テンプレートの手順でリポジトリを初期化した場合はすでに完了していると思われます.
  2. GitHubのシス管アカウント(ritscc-master)でログインし,右上のアイコンをクリック.Settings/Developer settings/Personal access tokensにアクセスし,Generate new tokenからトークンを発行し,手元に控えてください.なお発行する際は
Note : 総会リポジトリ名
Expiration : No expiration

を設定し,repoworkflowにチェックを入れ,ページ下部のGenerate new tokenをクリックしてください. なおこのトークンはsetup.pyによりissueを発行する際にも使用します.

  1. 今回使用する総会リポジトリのSettings/Secretsにアクセスし,New repository secretをクリックします.
Name : ACCESS_TOKEN
Value : 発行したトークン

を設定してください.

  1. Completed!

カスタマイズ

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

本リポジトリの.github.sample内には,実行する処理とその処理を実行する条件を定義したものが記述されています. ここを変更することで,ビルドの動作やデプロイの方法を変更することが可能です.

GitHub Actionsの仕様については,GitHub Actions について学ぶを参照してください.