-
Notifications
You must be signed in to change notification settings - Fork 200
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
整理: GitHub workflow step の命名規則を統一 #1139
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
方針良いと思います!
ただ変更が一長一短になってしまっているので解決策をコメントしてみました!
@Hiroshiba |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ほぼLGTMです!!
せっかくなのでということでコメントをいっぱい書いてしまったのですが、ドキュメントは書かれていることが何より良いので、比較的サラッと流しめで捉えていただければと思います 🙇
@Hiroshiba |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!!
ものすごく見通しが良くなったと思います、ありがとうございます!
こちらでちょっと細かいところだけ調整させていただこうと思います!
内容
概要: GitHub workflow step の命名規則を統一してリファクタリング
GitHub workflow の step 名(
jobs.<job_id>.steps[*].name
)はそのステップの概要を示し、GitHub の workflow UI 上に表示される。理想的にはこの UI 上で「どの段階がコケたのか(例: 環境構築、ビルド、テスト)」を知りたい。しかし現在の VOICEVOX ENGINE は step 名に命名規則がないため、一見してわからない。
もし命名規則があれば「環境構築がそもそも上手く行っていない」「新機能を入れたらテストが fail した」と直感的に理解できる。
このような背景から、GitHub workflow step の命名規則統一によるリファクタリングを提案します。
具体的には step を以下の大枠に分類し、step 名の最初の単語でこれを明示しました:
Set up ...
(例:Set up Python dependencies
)Build ...
(例:Build the application as 7z archives
)Test ...
(例:Test format
)Deploy ...
(例:Deploy documents to GitHub Pages
)一部の steps は上記段階の間にあるなどの事情で名称を維持しています。
関連 Issue
無し
Notes
この PR の Actions Jobs を見ると恩恵がわかると思います(例: test (ubuntu-20.04, 3.11.3))