GitHub Actions

[sfujiwara]

#36 何か CI 的なのがあった方が気分が盛り上がるかなと思って GitHub Actions で ./bin/run-docker コマンドがちゃんと正しく動くかチェックするようにしてみた

[chie8842]

これだとactions/checkout@v1 Dockerコンテナの上でさらにコンテナを起動することになるので、
uses: docker://tfug/proofreading:latestとして run:の中をbin/run tensorflow/docs master result.txtとしたほうが自然な気がします。

[sfujiwara]

僕もまだ GitHub Actions あんまりちゃんとわかっていないけれど、

• uses: actions/checkout@v1 みたいな use は処理の単位の区切り (action と呼ぶらしい) で、その単位ごとに任意のイメージを使ったり予め用意した処理を呼び出すことができる
  • Action を指していたり Docker image そのものを指していたりしてややこしい (?)
  • actions/checkout は公式に用意されているやつで CircleCI で言う checkout と同じ
    • https://github.com/actions/checkout
  • なので後ろの RedPen による check とかは actions/checkout とは別のコンテナで動かす形になっている
    • イメージを指定しなければ ubuntu-latest 上になる

みたいな感じっぽいです。

YAML がわかり辛いなと思ったので、こんな感じで修正してみました:

name: actions

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout
        uses: actions/checkout@v2

      - name: Check diff
        uses: docker://tfug/proofreading:latest
        with:
          args: ./bin/run tensorflow/docs master
    ...

[chie8842]

このCIジョブはすべてのブランチでのpushイベントに対して発火するように設定されていますが、その結果をバッチに出すとmasterはちゃんと動作しているのにfailが表示されてしまうということになり、メンテナンスされていないかのように受け取られます。

このリポジトリ上でGithub Actionsを使って実現できそうなことは以下の3つがあります。（他にもブランチの定期削除とかもできますが）

1. PRが出ているブランチに対するテスト
2. mergeされたmasterブランチの内容に対するテスト
3. on.scheduleを使って定期的にtensorflow/docsのmasterの内容をチェックする

このPRでの内容は上記の 1.と思ってレビューしましたが、バッチを出すとしたら2.か3.の結果に対して出すのが良いかと思います。

[sfujiwara]

たぶん今の状態だとバッジ上のステータスはブランチに関わらずデフォルトブランチである master のステータスが表示されるので、懸念しているような master 以外のブランチで CI 失敗して failed が表示されるということにはならないかと。
https://help.github.com/ja/actions/automating-your-workflow-with-github-actions/configuring-a-workflow#adding-a-workflow-status-badge-to-your-repository

[chie8842]

bin/runでは結果のファイルはresult.txtでなくても第3引数で指定できるようになっています。
#33 (comment) でコメントしましたが、result.txtに固定して引数で渡さないようにするのがいいかなと思っています。

[sfujiwara]

ここは #42 で修正済み
master 側で大きい修正が入ったので、いったん master をこっちの branch にマージして、ついでに conflict の解消とかしました

[sfujiwara]

これ RedPen で修正の要求が出ると終了コードが 1 になって CI コケた扱いになってしまうのか
どうしようかな...?

[sfujiwara]

./bin/run tensorflow/docs-l10n master all 10 みたいな感じで error limit を optional で設定できるようにして、CI 上では error limit を 10 に緩めてみた

[sfujiwara]

あれ？なんか [2020-02-02 21:08:26.665][ERROR] cc.redpen.Main - The number of errors "35" is larger than specified (limit is "10"). とかあるのに CI 通っちゃってるのでだめっぽいな・・・？