0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

README.mdにgithub actionsのワークフロー状態バッジをつける

Last updated at Posted at 2024-09-10

README.mdにgithub actionsのワークフロー状態バッジをつける

はじめに

最近、github actionsを使い始めました。github actionsを使って、ユニットテストを行なっているのですが、オープンソースなどを見るとpassingといったバッジがREADMEに付けられています(下のようなやつ)。

image.png

これカッコいいので真似したいと思い調べてみました。メモレベルですが、誰かの役に立てばいいなと思い記事にしました。

バッジの付け方(メモ)

一応、公式ページにきちんと手順が書かれていますが、手っ取り早く知りたい方向けになります。

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に挿入できます。

0
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?