夜は短し歩けよ未来大生

未来大生が人工知能を中心に勉強していく上で、学習メモや日記として書いていきます。

GitHub Actionsを使って,TeXをビルドする仕組み作ってみた

概要

GitHub ActionsというCIを用いて,リポジトリにPushすると自動的にTeXファイルからPDFファイルに出力するようなもの.出力はGitHub APIを使って,GitHub ReleaseのAssetsに添付します.

リポジトリ

READMEにも同様の説明があるよ リポジトリ

前提

  • Gitをある程度使える必要があります
  • GitHub Actionsはまだベータのため申請しておく必要があります(申請はコチラ)

使い方

  1. このリポジトリをFork
  2. プライベートリポジトリに設定(参考)
  3. forkしたリポジトリを自分のパソコンにClone
  4. [1回目のみ]Releaseが一つも無い場合 v0.0.0とかにして適当に作っておいてください
  5. ローカルでmain.texを編集
  6. [1回目のみ.]github/workflows/main.yml内repositoryの部分を自分のリポジトリに変更してください
  7. .github/workflows/main.yml内の一番下の行のtagsの値を変更(変更しないとファイルが正常にアップロードされません)
  8. リモートにPush
  9. ActionsでBuildの経過を確認(約9分程度で完了)
  10. GitHub ReleasesのAssetsにPDFファイルがあるので,適宜ダウンロードしてください

cloneした状態のmain.texでは,contents/の中に各sectionが入っているので,気に入らなければ大学から配布されているsample.texを元にして編集してください. 画像などのファイルはfigures/に入っているので,TeX Wikiを参考にしてください.

注意

  • 他のファイル名.texを使用したい場合は,.github/workflows/main.yml内のroot_fileのところの引数を変更してください
  • 一部配布されているsample.texと変更してある部分があるので気をつけてください.
  • bibファイルを使うとどうにもエラーが発生するので使えません.解決方法を教えて下さい. 使えるようになりました (2019/10/23)
  • CI上ではcacheを使えないので,Dockerのビルドに時間がかかります.Localに環境を作れるならLocalの方が爆速です.
  • 分からないことがあれば,最低丸1日は自分で調べてください.それでも分からなければissueなりTwitterなりに質問してください.
  • 問題があればissue, プルリクしてください.

Twitter :@tkr12051