003-ワークフローの命名規則.md

3. ワークフローの命名規則

ステータス

• 提案中
• 承認
• 否認
• 廃止
• 保留

背景

提供するワークフローの命名規則を決めたい。
Reusable Workflow は /.github/workflows に配置する必要があり、route06/actionsの利用者が参照するワークフローと自リポジトリでのみ利用するワークフローが混在することになる。この問題に対処するため、これらの区別ができるように命名規則を決めたい。

決定

• ワークフローのCaseは全てsnake_caseとする
• 自リポジトリでのみ利用するワークフローは、 my_{workflow_name}.yml とする

コンプライアンス

• ls-lintをCIで実行し、snake_caseに準拠しているかを確認する。

影響

• 良い影響として、route06/actionsのコントリビューターが、命名規則について判断する必要がなくなる