筑波大学情報科学類卒業論文テンプレート + CI
使い方
- このリポジトリをForkします.
- ForkしたリポジトリをCloneし,ローカルで卒論を書きます.
- PDFを生成したいcommitに
v
から始まる名前のタグをつけ,タグをPushします. - Github Actionsが作動し(例),リリースページのAssetsにPDF
graduation_article_(タグ名).pdf
が並びます(例).
カスタマイズ
.github/workflows/release.yml
Github Actionsの動作を定義するファイルです.Actionsをどのタイミングでトリガするのか,作成するリリースの名前,出力されるPDFの名前などが設定できます.
また,コンパイルする.tex
ファイルの名前やlatexのコンパイラ,コンパイル時の引数,tlmgr
経由で追加するtexパッケージの名前などが指定できます.
latexまわりの挙動については,こちらをご覧ください.
.latexmkrc
latexをlatexmk
を使ってコンパイルする際のあれこれを設定するファイルです.
注意
タグ名に/
が入っていると,Github Actionsがエラーを出します.
その他
tag名(バージョン名)をlatexの文書中で参照したい
Github Actionsの動作中,環境変数 release_version
が定義されています.なので,例えばプリアンブルなどで,
\usepackage{catchfile}
\newcommand{\getenv}[2][]{%
\CatchFileEdef{\temp}{"|kpsewhich --var-value #2"}{\endlinechar=-1}%
\if\relax\detokenize{#1}\relax\temp\else\let#1\temp\fi}
\getenv[\VERSION]{release_version}
と定義しておけば,文中に\VERSION
と書くだけでタグ名(バージョン名)が出てきます.同期や先輩,先生に読んでもらうときに,タイトルに添えるなどしておくとよいでしょう.
\title{(卒論タイトル名)\\ \VERSION}
ちなみにrelease_version
が定義されていないとき(ローカルでコンパイルするときなど)は,コンパイルエラーにはならず空白が出力されるようです.
LaTeX文書で絵文字が使いたい
.github/workflows/release.yml
のBuild PDF
のところでuseしているKaiseiYokoyama/latex-build-langja@master
をKaiseiYokoyama/latex-build-langja@emoji
に変えることで,BXcoloremoji
パッケージが使えます.
ライセンス
MIT ただし,予告なく変更される場合があります.