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라든지 할 수 있으면 편리할 것 같다고 생각하고 있습니다.