[CI]対象作業の検討

[shokorep]

Description

CI対象想定です。漏れありましたらご教示ください。

1. resthubにPRが出された時
   • Lintなど
2. 定時実行（スケジューリング）
   • 若様のSwaggerHubフィルタリング
3. 定時実行（スケジューリング）
   • （Resthub.jsonを読み取り → GithubからSample API Service.json or ymlを抽出） // CIが抽出する場合この作業有
   • OpenAPI3（APIドキュメント）がymlの場合、jsonに変換
   • aspidaの型定義ファイルを生成→node packageとしてnpmに登録
   • OpenAPI3（APIドキュメント）をS3に格納

[maccostar]

検討ありがとうございますー！
定期実行する脆弱性チェック以外は、概ねイベントの抜け漏れはなさそうですね。

あとはレビューの際に自分で検討していて、以下の点に気づきました...。

• SwaggerHubフィルタリングのツールはおそらくAPI typesリポジトリに格納する

リポジトリ別にイベント整理した方がよさそうだったので、下記にもう少し詳細化したものを記載しておきます！
(これってCIでできるの？というのが調べてもわからないものがあったので、@hi85 のご協力もいただきながら引き続き調査しましょう〜)

RESThubリポジトリ

1. PR,pushされた際

   • Build JOB:setup
     npm i 等のビルドに必要なコマンドを実行
   • Test JOB:lintチェック
   • Test JOB:test
     **frontのみで自動化できるテストがあるか要検討
   • Deploy JOB:deploy(マージされた時のみ実行)
     **今じゃなくてよいが、masterブランチ→production / developブランチ→stagingとかの運用はあとで考える
     　

2. 定期実行(脆弱性チェック)

   • Build JOB(?):audit
     yarn auditの実行
   • Build JOB(?):upgrade
     yarn upgradeの実行
     **自動でupgradeさせる懸念はないか要ヒアリング
   • Test JOB:test
     **frontのみで自動化できるテストがあるか要検討
   • Deploy JOB:deploy
     　

API typesリポジトリ

1. PR,pushされた際

   • Build JOB:setup
     npm i 等のビルドに必要なコマンドを実行
   • Test JOB:lintチェック
   • Test JOB:test
     **frontのみで自動化できるテストがあるか要検討
   • Deploy JOB:deploy(マージされた時のみ実行)
     　

2. 定期実行(脆弱性チェック)

   • Build JOB(?):audit
     yarn auditの実行
   • Build JOB(?):upgrade
     yarn upgradeの実行
     **自動でupgradeさせる懸念はないか要ヒアリング
   • Test JOB:test
     **frontのみで自動化できるテストがあるか要検討
   • Deploy JOB:deploy
     　

3. 定期実行(ギャザー)
   JOBのフェーズがわからないので、job/command/execだけ記載。
   実行順は、gather → generateJson → (分岐1/分岐2) → deployのイメージ

   • gatherSwaggerHub (若様batの実行(?))
   • gatherGithub (定時実行（スケジューリング)
   • generateJson
     OpenAPI3（APIドキュメント）がymlの場合、jsonに変換
     // CIが抽出する場合この作業有
   • (分岐1)
     • generateApiInterface
       aspidaの型定義ファイルを生成
     • generateTest
       テストコードを自動生成(?)
     • gitPush
       API typesリポジトリにpush(?)
     • setup
     • ApiTest
       APIテストの実行
     • npmPublish
       node packageとしてnpmに登録
   • (分岐2)
     • RESThubTest
       **frontのみで自動化できるテストがあるか要検討
   • deploy
     OpenAPI3（APIドキュメント）をS3に格納

参考情報

• mugensweeperのCI設定等
  https://github.com/hackersjail/mugensweeper/blob/develop/.circleci/config.yml
  https://circleci.com/workflow-run/b17a31f9-0ff1-4a86-925a-1311070a4e6a
  https://circleci.com/workflow-run/2b893621-f1d1-4b44-a155-a80ef2568e40

• npmモジュール公開
  https://qiita.com/hoshimado/items/c6f1484297d974f44f19

• (私が知らなかったので調べた)そもそも系資料
  https://qiita.com/gold-kou/items/4c7e62434af455e977c2

• github actionsのトリガー
  https://help.github.com/ja/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows

その他

手書きで整理した際の絵

[shokorep]

memo

• gitPush
  　できる
  　gitPushのexample: https://github.com/beet-aizu/github_actions

• npmPublish
  　おそらくできる（terminalでできることはCIでできると理解）
  　npm パッケージ登録を行う: https://qiita.com/TsutomuNakamura/items/f943e0490d509f128ae2
  TODO
  　パッケージのバージョン設定のロジックをどうするか考える
  　（そもそもバージョン設定ができるのか？？）

[shokorep]

調査事項（実行可能か？ ）

API typesリポジトリ

3. 定期実行(ギャザー)

• gatherGithub (定時実行（スケジューリング)
  （githubでAPIを公開している && RestHub.jsonが存在する）リポジトリにアクセスし、OpenAPI spec 3.0を取得する。

github actionsでやろうとしていることの全容は以下です。
#16 (comment)

[maccostar]

脆弱性のupgradeには、いずれか(もしくは双方)を入れる。

• https://github.com/apps/renovate
  →使う場合は設定を共通化することはできる。
• https://dependabot.com/

[shokorep]

RESThubリポジトリ

• PR,pushされた際

1. Build JOB:setup
2. npm i 等のビルドに必要なコマンドを実行
3. Test JOB:lintチェック
4. Test JOB:test
   frontのみで自動化できるテストがあるか要検討
5. Deploy JOB:deploy(マージされた時のみ実行)
   今じゃなくてよいが、masterブランチ→production / developブランチ→stagingとかの運用はあとで考える
   　

• 定期実行(脆弱性チェック)

1. Build JOB(?):audit
2. yarn auditの実行
3. Build JOB(?):upgrade
4. yarn upgradeの実行
   自動でupgradeさせる懸念はないか要ヒアリング
5. Test JOB:test
   **frontのみで自動化できるテストがあるか要検討
6. Deploy JOB:deploy
   　

API typesリポジトリ

• PR,pushされた際（bot）

1. Build JOB:setup
2. npm i 等のビルドに必要なコマンドを実行
3. Test JOB:test
4. git push（API typesリポジトリにpush）

• PR,pushされた際（docs）

1. Build JOB:setup
2. npm i 等のビルドに必要なコマンドを実行
3. OpenAPI 3.0の形式かチェック
   　→v3のみをAccept
4. git push（API typesリポジトリにpush）

　

• 定期実行(脆弱性チェック)　今後導入（今はしない）

1. Build JOB(?):Renovate or Dependabotの検討
2. Test JOB:test
   **frontのみで自動化できるテストがあるか要検討
3. git push（API typesリポジトリにpush）

　

• 定期実行(ギャザー)

1. gatherSwaggerHub (若様batの実行(?))　
2. generateJson
   OpenAPI 3.0の形式かチェック
   　→v2ならv3に変換
   　OpenAPI3（APIドキュメント）がymlの場合、jsonに変換
3. resthub表示用のAPIリスト.jsonを生成
4. typesリポジトリにPush、S3に配置
   1.(分岐1)generateApiInterface
   　aspidaの型定義ファイルを生成
   　　generateTest
   　　テストコードを自動生成(?)
   　gitPush（API typesリポジトリにpush）
   　setup
   　　ApiTest APIテストの実行
   　npmPublish
   　node packageとしてnpmに登録
5. (分岐2)RESThubTest
   　APIリスト.jsonに記載されているファイルがdocs配下にあるかをテスト

[maccostar]