GitHub Actionsを使ってLaTeX文書をAspellでスペルチェックする

はじめに

英語論文のスペルチェックにAspellを使ってる人は多いと思います。自分でローカルで実行する分には良いのですが、共同で執筆している場合などは軽微なスペルミスはあまり指摘したく/されたく無いですよね。こういう仕事にはCIツールが向いています。

最近、GitHub ActionsというGitHubのCIツールがベータ公開されました。ということで、早速Aspellを使って自動的にLaTeX文書をスペルチェックしてくれるGitHub Actionを作成してみました。

成果物はGitHub Actions for Aspellで公開しています。

使用方法

まず、リポジトリのルートディレクトリに .aspell.en.pws というファイル名でユーザ辞書を置きます。ユーザ辞書の作り方の詳細は省略しますが、大抵は以下のようなコマンドで辞書を作るのでは無いでしょうか。

$ aspell --dont-backup --lang=en --mode=tex --personal ./.aspell.en.pws -c main.tex

次に、リポジトリのルートディレクトリに .github/main.workflow を以下のように作成して .aspell.en.pws と一緒に git push します。

なお、ASPELL_PERSONAL の ./ は省略すると動かないようです。

workflow "Spell Checking with Aspell" {
  on = "push"
  resolves = ["GitHub Action for Aspell"]
}

action "GitHub Action for Aspell" {
  uses = "mh61503891/action-paper-aspell@master"
  env = {
    ASPELL_LANG = "en"
    ASPELL_MODE = "tex"
    ASPELL_PERSONAL = "./.aspell.en.pws"
    ASPELL_FILES = "main.tex main.bib"
  }
}

すると push イベントに反応してDockerでaspell が実行され、スペルミスが無ければ成功、有れば失敗します。

GitHub Actionsの作成方法メモ

• GitHub Actions | GitHub Developer Guide - まずは公式ドキュメントに目を通した方が良さそうです。
• GitHub Actions - 様々なアクションが登録されています。書き方の参考になります。
• sdras/awesome-actions: A curated list of awesome actions to use on GitHub
• Topic: github-actions

今後

スペルチェックだけでなく学会の執筆要項に準拠しているかをチェックするLinterとかできたら便利そうだなと考えています。