【GitHub】ステータスバッジの表示機能が追加されました【Actions CI/CD】
GitHub Actions CI/CDでもstatus badgeが貼れるようになったぞ!!! #GitHub https://t.co/6Y0IHRBEvX pic.twitter.com/qHG4ydQE5u
— Ryota.I (@_pavlog) 2019年9月8日
めでたい🎉🎉🎉
ohh heeyy
— Mike Coutermarsh (@mscccc) September 7, 2019
the official @github Actions status badges just landed in the docs.https://t.co/z6RBb83JQM
design by @jasonlong, code by @mxie pic.twitter.com/g7PONjVa4f
このツイートにあるように、公式からステータスバッジの機能がドキュメントへ追加されました!
what's GitHub Actions and CI/CD
Actionsには触れていませんが、GitHub Actions CI/CDには以下で触れています。
Status badge
ステータスバッジは、ワークフローの失敗や成功を示すものです。
これを追加するのは一般的にはREADME.mdファイルなどですが、任意のWebページにも追加が可能です。
バッジにはデフォルトブランチ(通常はmasterブランチ)のステータスが表示されます。
Badgeの取得・添付方法
具体的には以下のページで触れていますが、わかりやすく説明を書いていこうと思います。
Configuring a workflow - GitHub Help
- ワークフローにnameキーワードを使用している場合
以下のURLの通りにすることで貼ることが可能です。
https://github.com/<OWNER>/<REPOSITORY>/workflows/<WORKFLOW_NAME>/badge.svg
具体例は以下です。
WORKFLOW_NAMEの部分は以下の部分の情報を挿入します。
空白文字については、 %20
で表記する必要があります。
compilerbook/test.yaml at master · paveg/compilerbook · GitHub
- ワークフローにnameキーワードを使用していない場合
(※試しましたが、うまく動かなかったのでわかり次第追記します。)
おわりに
ステータスバッジをwebページやGitHubのREADME.mdへ貼ることでワークフローのステータスも一瞥できるようにすると僕はテンションが上がります。
これを機会にぜひバッジを貼ってみてはいかがでしょうか!!!