CIの実行条件を変更する

[ghost]

PR の目的

CIの実行条件を変更する。

カテゴリ

• ビルド関連
  • Azure Pipelines
  • AppVeyor
  • GitHub Actions

PR の背景

ブランチ名の固定をやめたい

• GitHubのデフォルトブランチがmainに変更されました。
  これに合わせてブランチ名を変更すると、CIが実行されなくなります。
• ブランチ名を柔軟に指定できるようにしたいです。
  PR予定がない動作確認用のブランチでも特定のプレフィクスを付加しないとCIが実行されません。
• 既に想定しているブランチ名と異なる名前のブランチからPRが出されています。
  過去にマージしたPRのうち、いくつかは実行条件で想定されているブランチ名と異なる名称でした。
• そもそもAppVeyorのジョブとSonarCloudの解析を行うワークフローには、ブランチ名の条件は課していません。

除外条件をそろえたい

• 各CIで除外対象ファイルに違いがあります。
  このため、特定ファイルの変更を実施した際に実行状況に違いが生じてしまいます。
• Azure Pipelinesでもワイルドカードがサポートされました。
  現在の対象ファイルを個別に列挙する方法では、新たに対象とすべきファイルがリポジトリに追加されたときに更新し忘れる可能性があります。

GitHub Actionsを手動で実行したい

• 外部の要因によってワークフローが失敗したとき、コミットの追加以外の方法で再試行できるようにしたいです。
• AppVeyorとAzure Pipelinesではできています。

PR のメリット

• どのようなブランチ名であってもCIが実行されるようになります。
• 除外条件が統一され、実行タイミングが一致します。
• すべてのCIでビルドを手動実行できるようになります。

PR のデメリット (トレードオフとかあれば)

仕様・動作説明

1. 実行条件からブランチ名の記述を削除しました。
2. Azure Pipelinesで除外ファイルをワイルドカードで指定しなおしました。
3. 各CIで同じファイルないしディレクトリが除外対象となるようにしました。
4. workflow_dispatchイベントに対応させ、ワークフローを手動実行できるようにしました。

PR の影響範囲

• すべてのCI

テスト内容

• 事前に除外対象ファイルの変更をコミットして、実行されないことを確認済みです。
• リポジトリのデフォルトブランチにこの作業ブランチを設定して、GitHub Actionsワークフローを手動実行できるようになったことを確認済みです。

関連 issue, PR

#1761 … 直近でブランチ名が想定と異なっていた事例

参考資料

2020-10-01付: The default branch for newly-created repositories is now main | GitHub Changelog
2021-09-08付: Support for wild cards and conditional expressions in YAML pipeline files | Microsoft Docs
Manually running a workflow - GitHub Docs

[ghost]

…ということを #1752 の対応時に感じたので、とりあえず出してみます。
反応次第では取り下げますのでご意見ください。

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[AppVeyorBot]

✅ Build sakura 1.0.4020 completed (commit b16f2f8c87 by @kazasaku)

[berryzplus]

デフォルトブランチ名を main に変える件は、

何年か前に「変更を検討しませんか？」の issue が立った気がします。
たしか、the default branch for newly created repository ってことは関係ないね！が結論だったような。

というか、この対応の内容って
GitHubが「新規リポジトリのデフォルトブランチをmainに変えた」こととは関係ないような（笑

「CIを任意のブランチで実行できるように改良する」ですかね、実態は。

「CIの実行条件を変更する」でも間違いではないけれど、ニュアンスが大分違うような。

[ghost]

CIを任意のブランチで実行できるように改良する

本文に「ブランチ名を柔軟に指定できるようにしたいです。」と書きました。

このPRは対象ブランチ名・除外ファイルパス・対象イベントの3つをまとめて「CIの実行条件」としています。

[ghost]

やっぱりまとめすぎですね。分割します。

[ghost]

#1788 を出しました。
残り2つは後程。