More than 3 years have passed since last update.

流行りのCIを導入して卒論を爆速で書き上げる

Last updated at 2020-08-12Posted at 2020-08-09

モチベーション

大学生にとっての最終試練…
はい。卒論執筆の季節がもうすぐやって参ります。

文字数多いと校正とかめんどくさいなぁ。

うーん、CIで自動化しちゃお！w

世間はzoomだGoogle Meetだと躍起になっていますが、時代はCIですよCI。

CIとは？

ここでCIについて軽くおさらいしておきます。

CIとは、Continuous Integrationの略で、継続的インテグレーションと呼ばれています。
CI(継続的インテグレーション)では、開発者が自分のコード変更を頻繁にセントラルリポジトリにマージし、その度に自動化されたビルドとテストを実行します。
小さなサイクルでインテグレーションを繰り返し行い、インテグレーションのエラーを素早く修正することによりチームは統合されたソフトウェアをより迅速に開発できるようになります。
--- CI(継続的インテグレーション)とは | CloudBees Jenkins より引用

まとめると、成果物(文章やコードなど)がある程度完成する度に自動テストでチマチマ修正して、計画的且つ迅速に開発・作成を行う手法のことです。

--- CI(継続的インテグレーション)とは | CloudBees Jenkins より画像引用

簡単に言えば、夏休みのドリルを取り組む度に丸つけをして、間違いを修正しながら確実に学力をつけていくイメージですね!
(もちろん僕は最後にまとめて丸つけをするタイプでした。笑)

今回やること

そんなわけで導入しましょう流行りのCI。

導入したい必須機能は以下の通り。

文章中の間違いとかを自動で校正してくれる。
校正結果が簡単に確認できる。
ファイルを投げたら教授に自動通知してくれる。
教授が簡単にファイルをダウンロードできる。

あとは補助機能として、

多数のユーザーでも各々でCIが動く。
内容がそれぞれ別々に通知される。

とかあったらゼミ仲間にも使ってもらえそう。

実装

完成後のファイルパスは以下のようになります。

Sotsuron_CI/ ---- .travis.yml (2-1.で作成。3-2.で追記。)
              |
              |-- .textlintrc (2-2.で作成)
              |
              |-- sample_sotsuron.docx (卒論本文)
              |
              |-- README.md (リポジトリ作成時に自動生成されただけ。無しでも支障なし。)

1. CIを行う環境を整える

とりあえず今回はTravis CIを使ってみます。(無料だし。)

--- Travis CI | narito ブログより画像引用

よってCIを行う環境はGithubリポジトリになります。

--- Travis CI から GitHub へ git push を行う設定 | Tips Note by TAM より画像引用

簡単すぎるので割愛しますが、ここでは以下の作業を行います。

↑もし手順とか忘れた場合は、各リンク先のページを参考にしてください！
※ Travis CIのリンク先での「COVERALLSと連携させるステップ」は不要ですので飛ばしてOKです。

2-1. 文章の自動校正を導入

ここからTravis CIで行う機能をコードとして実装していきます。

今回、文章の自動校正にはtextlintを使用します。
ですが、textlintはMicrosoft Wrodの文書(.docx)に非対応であるため、文書の形式を変更させなければ校正できません。
そこで校正する前にMicrosoft Wrodの文書(.docx)をMarkdown文書(.md)に変換するpandocを利用します。

つまり流れとしては、

pandocで卒論を.docx形式から.md形式に変換。
textlintで文章を自動校正。

という感じです。

それではリポジトリに.travis.ymlを作成して以下のコードを追加します。

.travis.yml

sudo: false
language: node_js
node_js:
  - '8.12.0'
before_script:
  - sudo apt-get update -y
  - sudo apt-get install pandoc libghc-pandoc-prof
  - pandoc -s sample_sotsuron.docx -t markdown -o sample_sotsuron.md
  - npm init -y
  - npm install textlint --save-dev
  - npm install textlint-rule-preset-ja-technical-writing --save-dev
  - npm install npx --save-dev
script:
  - npx textlint --preset ja-technical-writing sample_sotsuron.md -f pretty-error

textlintがnode_jsで作成されているためlanguageはnode_jsを指定します。

ちなみにTravis CIはUbuntuのDockerコンテナ上で動くため、pandocやtextlintのインストールはapt-getで行います。

また、今回の文章校正ルールとして、
textlint-rule-preset-ja-technical-writing
を指定し、技術文書向けのtextlintルールプリセットを使用しています。

npmで必要なものをインストールして、最後にnpxでtextlintを起動させています。
(ちなみにtextlintコマンド内の-f pretty-errorはtextlintの出力形式を表すオプションです。)

2-2. textlintルールプリセットの修正

今回、技術文書向けのtextlintルールプリセットを用いて卒論を校正するわけですが、
デフォルト設定のルールは結構厳しめです…

このままでは卒業が危うくなってしまうので、適宜ルールを修正します。

リポジトリに.textlintrcを作成して以下のコードを追加します。

.textlintrc

{
  "filters": {},
  "rules": {
    "preset-ja-technical-writing": {
      "sentence-length": {
          "max": 150
        },
      "max-kanji-continuous-len": {
          max: 10
      },
      "max-comma": {
        "max": 5
      },
      "ja-no-mixed-period": false,
      "ja-unnatural-alphabet": false,
      "no-exclamation-question-mark": false,
      "no-unmatched-pair": false,
    }
  }
}

preset-ja-technical-writingの内容を以下のように修正しています。

sentence-length: 1文の文字数 (最大:100→150に変更)
max-kanji-continuous-len: 連続する漢字長 (最大:6→10に変更)
max-comma: 1文中のカンマ数 (最大:3→5に変更)
ja-no-mixed-period: 文末の句点記号 (falseで校正ルールから外す)
ja-unnatural-alphabet: 不自然なアルファベットをチェック (falseで校正ルールから外す)
no-exclamation-question-mark: 感嘆符(!, ?)をチェック (falseで校正ルールから外す)
no-unmatched-pair: 1文中の[]や「」のペアをチェック (falseで校正ルールから外す)

これらの記述はtextlintを起動する際に内部的に自動で参照されます。
(.travis.ymlの修正も不要。)

※記載した以外のルールはデフォルト設定で適用されています。

3-1. CIの結果をSlackに自動通知

次に卒論ファイルが更新されたことをSlackに自動通知させます。

まずはSlackとTravis CIを連携させます。
先人の知恵をお借りして、以下のQiita記事を参考にしてください。

図解: Travis CIの結果をSlack通知する方法

ただし、今回 2-1. 文章の自動校正を導入 で作成した.travis.ymlは以下のように変更してください。

.travis.yml

sudo: false
language: node_js
node_js:
  - '8.12.0'
before_script:
  - sudo apt-get update -y
  - sudo apt-get install pandoc libghc-pandoc-prof
  - pandoc -s sample_sotsuron.docx -t markdown -o sample_sotsuron.md
  - npm init -y
  - npm install textlint --save-dev
  - npm install textlint-rule-preset-ja-technical-writing --save-dev
  - npm install npx --save-dev
script:
  - npx textlint --preset ja-technical-writing sample_sotsuron.md -f pretty-error
### 以下の部分を追加 ###
notifications:
  email: false
  slack:
    rooms:
      - secure: <YOUR TOKEN>
    template:
      - "Sotsuron checked on `sample_sotsuron`."
      - "Result: <https://travis-ci.org/github/USER_NAME/REPOSITORY_NAME/branches|%{message}>"
      - "----------------------------------------"
      - "Download Sotsuron: https://github.com/USER_NAME/REPOSITORY_NAME/raw/%{branch}/sample_sotsuron.docx"

secureの値となっている<YOUR TOKEN>は図解: Travis CIの結果をSlack通知する方法と同様にAPIトークンをご自身で設定してください。

templateはSlackに通知されるメッセージのテンプレートです。
またテンプレート内のURLは以下の通りです。

Result : CIの実行結果リンク
Download Sotsuron : ブランチに更新された卒論ファイルのダウンロードリンク

URL内部のUSER_NAME/REPOSITORY_NAMEはご自身のGitHubアカウント名とリポジトリ名に置き換えてください。

Slack上では以下のように通知されます。

これで教授にいちいち連絡しなくても卒論を書き進められますね。

3-2. 通知内容をブランチごとに分ける

最後にブランチごとにSlackへの通知内容が変更されるようにしましょう。
これは各ゼミ生にそれぞれブランチを割り当てることで複数人の卒論を管理できるようにするための実装です。

下記のように.travis.ymlを変更してください。

.travis.yml

### 新規追加 ###
branches:
  except:
    - master
###############
sudo: false
language: node_js
node_js:
  - '8.12.0'
before_script:
  - sudo apt-get update -y
  - sudo apt-get install pandoc libghc-pandoc-prof
## 修正 ##
  - pandoc -s ${TRAVIS_BRANCH}.docx -t markdown -o ${TRAVIS_BRANCH}.md
##########
  - npm init -y
  - npm install textlint --save-dev
  - npm install textlint-rule-preset-ja-technical-writing --save-dev
  - npm install npx --save-dev
script:
## 修正 ##
  - npx textlint --preset ja-technical-writing ${TRAVIS_BRANCH}.md -f pretty-error
##########
notifications:
  email: false
  slack:
    rooms:
      - secure: <YOUR TOKEN>
    template:
    ## 修正 ##
      - "Sotsuron checked on `%{branch}`."
      - "Result: <https://travis-ci.org/github/USER_NAME/REPOSITORY_NAME/branches|%{message}>"
      - "----------------------------------------"
      - "Download Sotsuron: https://github.com/USER_NAME/REPOSITORY_NAME/raw/%{branch}/%{branch}.docx"
    ##########

branchesでmasterブランチを除外しています。アプリ開発などではmasterへのpush時にCIを発動させることが多いですが、今回はmasterをCIパイプラインの管理に使用したいのでこのように設定しました。

pandocやtextlintを実行する際に呼び出すTRAVIS_BRANCHはTravis CI発動時の環境変数であり、CIを動かしているブランチ名が入ります。

よって今回はブランチ名と卒論ファイル名を一致させることで、複数人の卒論を管理できるようにしました。

またnotifications内に記載した%{branch}はSlack通知時にCIを実施したブランチ名に置き換えられる変数です。

この実装によって以下のような通知ができるようになりました。

※ブランチ名はexample_user_sotsuronで作成しています。

最後にCIを動かしてみる

最後に今回実装した卒論CIをGitHub.comのGUIで動かして確認してみます。

1. ブランチの作成

まずはmasterを元に新規ブランチを作成します。

左上のmasterと表記されているブランチボタンをクリックしてSwitch branches/tagsメニューを開き、テキストボックスにブランチ名を記入して下のCreate branch: ブランチ名 from 'master'をクリックします。