README.mdにgithub actionsのワークフロー状態バッジをつける
はじめに
最近、github actionsを使い始めました。github actionsを使って、ユニットテストを行なっているのですが、オープンソースなどを見るとpassing
といったバッジがREADMEに付けられています(下のようなやつ)。
これカッコいいので真似したいと思い調べてみました。メモレベルですが、誰かの役に立てばいいなと思い記事にしました。
バッジの付け方(メモ)
一応、公式ページにきちんと手順が書かれていますが、手っ取り早く知りたい方向けになります。
GitHub Docs: ワークフロー状態バッジの追加
結論
以下のファイルを画像としてリンクするだけで、OKです。オーナー名、リポジトリ名は自分のgithubでの名前とリポジトリ名です。yamlファイル名はActionsのファイル名です。
https://github.com/[オーナー名]/[リポジトリ名]/actions/workflows/[yamlファイル名]/badge.svg
具体的には、![...](URL)
の形式でREADME.mdに埋め込みます。
markdownへの記述
![ワークフロー名](https://github.com/[オーナー名]/[リポジトリ名]/actions/workflows/[yamlファイル名]/badge.svg)
これだけで、Actionsの結果をバッジにしてREADME.mdに挿入できます。