ワークフロー バッジを調べる

完了

ワークフローステータスバッジは、プロジェクトの正常性とビルドの状態をひとめで確認できます。 これらは、リポジトリにアクセスするユーザー、共同作成者、利害関係者にプロジェクトの品質を伝えるために不可欠です。

ワークフロー バッジについて

ステータス バッジは、GitHub Actions ワークフローの現在の状態を表示する動的イメージです。 最新のビルド状態を反映するように自動的に更新され、プロジェクトの CI/CD パイプラインの正常性に関する視覚的なフィードバックが即座に提供されます。

ワークフロー バッジが重要な理由

プロジェクトの信頼性: バッジは、プロジェクトが適切な開発プラクティスに従っていることを示す クイック評価: 共同作成者は、プロジェクトが安定した 品質保証であるかどうかをすぐに確認できます。失敗したバッジは、プロフェッショナルな 外観を必要とする問題に対してメンテナンス担当者に警告します。適切に構成されたバッジは、プロジェクトのプロフェッショナルイメージを強化します

ワークフロー バッジの作成と構成

基本的なバッジ構文

GitHub Actions ワークフロー バッジの標準 URL 形式は次のとおりです。

https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg

URL コンポーネント:

• <OWNER>: GitHub のユーザー名または組織名
• <REPOSITORY>: リポジトリ名
• <WORKFLOW_FILE>: ワークフローのファイル名 (例: ci.yml)

ブランチ固有のバッジ

ブランチ パラメーターを追加して、特定のブランチの状態を表示します。

https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg?branch=<BRANCH_NAME>

実用的なバッジの実装

基本的な README.md 統合

# My Awesome Project

![CI](https://github.com/myorg/myproject/actions/workflows/ci.yml/badge.svg)
![Deploy](https://github.com/myorg/myproject/actions/workflows/deploy.yml/badge.svg)

[![Build Status](https://github.com/myorg/myproject/actions/workflows/ci.yml/badge.svg)](https://github.com/myorg/myproject/actions/workflows/ci.yml)

A description of your project...

マルチブランチバッジディスプレイ

# Project Status

| Branch  | Status                                                                                                  |
| ------- | ------------------------------------------------------------------------------------------------------- |
| Main    | ![Main Branch](https://github.com/myorg/myproject/actions/workflows/ci.yml/badge.svg?branch=main)       |
| Develop | ![Develop Branch](https://github.com/myorg/myproject/actions/workflows/ci.yml/badge.svg?branch=develop) |
| Release | ![Release Branch](https://github.com/myorg/myproject/actions/workflows/ci.yml/badge.svg?branch=release) |

高度なバッジ コレクション

# Build & Quality Status

[![CI Pipeline](https://github.com/myorg/myproject/actions/workflows/ci.yml/badge.svg)](https://github.com/myorg/myproject/actions/workflows/ci.yml)
[![Security Scan](https://github.com/myorg/myproject/actions/workflows/security.yml/badge.svg)](https://github.com/myorg/myproject/actions/workflows/security.yml)
[![Deploy to Production](https://github.com/myorg/myproject/actions/workflows/deploy.yml/badge.svg)](https://github.com/myorg/myproject/actions/workflows/deploy.yml)
[![Code Coverage](https://codecov.io/gh/myorg/myproject/branch/main/graph/badge.svg)](https://codecov.io/gh/myorg/myproject)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

ワークフロー バッジのベスト プラクティス

戦略的バッジの配置

README のトップ: プライマリ ビルド状態が最も目立つ場所 状態セクション: プロジェクトの健康状態用の専用セクション プルリクエストテンプレート: コンテキストとして PR の説明にバッジを含める

<!-- In your README.md -->

# Project Name

![Build](https://github.com/owner/repo/actions/workflows/build.yml/badge.svg)
![Tests](https://github.com/owner/repo/actions/workflows/test.yml/badge.svg)

<!-- Rest of your README content -->

## Status Dashboard

### Build Pipeline

- **Main Branch**: ![Main](https://github.com/owner/repo/actions/workflows/ci.yml/badge.svg?branch=main)
- **Development**: ![Dev](https://github.com/owner/repo/actions/workflows/ci.yml/badge.svg?branch=develop)

### Quality Metrics

- **Code Coverage**: ![Coverage](https://codecov.io/gh/owner/repo/branch/main/graph/badge.svg)
- **Security**: ![Security](https://github.com/owner/repo/actions/workflows/security.yml/badge.svg)

わかりやすいワークフロー名

明確なバッジ ラベルを作成するわかりやすい名前がワークフロー ファイルにあることを確認します。

# .github/workflows/ci.yml
name: "CI Pipeline"  # Creates badge with "CI Pipeline" label

# .github/workflows/deploy-production.yml
name: "Production Deployment"  # Creates badge with "Production Deployment" label

# .github/workflows/security-scan.yml
name: "Security Analysis"  # Creates badge with "Security Analysis" label

バッジの組織パターン

関数別にグループ化:

## Build & Test

![CI](https://github.com/owner/repo/actions/workflows/ci.yml/badge.svg)
![Tests](https://github.com/owner/repo/actions/workflows/test.yml/badge.svg)

## Deployment

![Staging](https://github.com/owner/repo/actions/workflows/deploy-staging.yml/badge.svg)
![Production](https://github.com/owner/repo/actions/workflows/deploy-prod.yml/badge.svg)

## Quality & Security

![CodeQL](https://github.com/owner/repo/actions/workflows/codeql.yml/badge.svg)
![Dependency Check](https://github.com/owner/repo/actions/workflows/deps.yml/badge.svg)

リンク付きの対話型バッジ

バッジをクリック可能にして、ワークフローの詳細に直接アクセスできるようにします。

[![Build Status](https://github.com/owner/repo/actions/workflows/ci.yml/badge.svg)](https://github.com/owner/repo/actions/workflows/ci.yml)
[![Deploy Status](https://github.com/owner/repo/actions/workflows/deploy.yml/badge.svg)](https://github.com/owner/repo/actions/workflows/deploy.yml)

カスタム バッジの統合

サード パーティのサービス バッジ

外部サービス インジケーターを使用して GitHub Actions バッジを補完します。

<!-- Combine GitHub Actions with external services -->

![GitHub Actions](https://github.com/owner/repo/actions/workflows/ci.yml/badge.svg)
[![Codecov](https://codecov.io/gh/owner/repo/branch/main/graph/badge.svg)](https://codecov.io/gh/owner/repo)
[![Dependabot](https://api.dependabot.com/badges/status?host=github&repo=owner/repo)](https://dependabot.com)
[![npm version](https://badge.fury.io/js/package-name.svg)](https://badge.fury.io/js/package-name)

動的バッジのコンテンツ

追加情報を表示するバッジを作成します。

<!-- Show specific branch status -->

![Main Branch](https://github.com/owner/repo/actions/workflows/ci.yml/badge.svg?branch=main&event=push)

<!-- Show latest release status -->

![Release](https://github.com/owner/repo/actions/workflows/release.yml/badge.svg?branch=main&event=release)

バッジのトラブルシューティングと監視

一般的な問題と解決策

バッジが更新されない:

• URL でワークフロー ファイルのパスを確認する
• ワークフローが少なくとも 1 回完了したことを確認する
• ワークフロー名が正確に一致することを確認する

バッジに "不明" 状態が表示されます。

• ワークフロー ファイルが存在しないか、構文エラーがある
• リポジトリまたはワークフローが適切なアクセス許可なしでプライベートである
• URL パラメーターの形式が正しくありません

バッジの状態の監視

バッジの状態の変更に関するアラートを設定します。

# .github/workflows/badge-monitor.yml
name: Badge Status Monitor

on:
  workflow_run:
    workflows: ["CI Pipeline"]
    types: [completed]

jobs:
  notify-status:
    runs-on: ubuntu-latest
    if: ${{ github.event.workflow_run.conclusion == 'failure' }}
    steps:
      - name: Notify team of failing badge
        uses: 8398a7/action-slack@v3
        with:
          status: failure
          text: "🚨 CI Pipeline badge is now showing failure status"
        env:
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

高度なバッジ戦略

複数環境ダッシュボード

## Environment Status

| Environment     | Build                                                                                     | Deploy                                                                                  | Health Check                                                                            |
| --------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| **Development** | ![Build](https://github.com/owner/repo/actions/workflows/ci.yml/badge.svg?branch=develop) | ![Deploy](https://github.com/owner/repo/actions/workflows/deploy-dev.yml/badge.svg)     | ![Health](https://github.com/owner/repo/actions/workflows/health-dev.yml/badge.svg)     |
| **Staging**     | ![Build](https://github.com/owner/repo/actions/workflows/ci.yml/badge.svg?branch=staging) | ![Deploy](https://github.com/owner/repo/actions/workflows/deploy-staging.yml/badge.svg) | ![Health](https://github.com/owner/repo/actions/workflows/health-staging.yml/badge.svg) |
| **Production**  | ![Build](https://github.com/owner/repo/actions/workflows/ci.yml/badge.svg?branch=main)    | ![Deploy](https://github.com/owner/repo/actions/workflows/deploy-prod.yml/badge.svg)    | ![Health](https://github.com/owner/repo/actions/workflows/health-prod.yml/badge.svg)    |

プロジェクトヘルスダッシュボード

# Project Health Dashboard

## Core Pipeline

[![Build](https://github.com/owner/repo/actions/workflows/build.yml/badge.svg)](https://github.com/owner/repo/actions/workflows/build.yml)
[![Test](https://github.com/owner/repo/actions/workflows/test.yml/badge.svg)](https://github.com/owner/repo/actions/workflows/test.yml)
[![Lint](https://github.com/owner/repo/actions/workflows/lint.yml/badge.svg)](https://github.com/owner/repo/actions/workflows/lint.yml)

## Security & Quality

[![Security Scan](https://github.com/owner/repo/actions/workflows/security.yml/badge.svg)](https://github.com/owner/repo/actions/workflows/security.yml)
[![Dependency Audit](https://github.com/owner/repo/actions/workflows/audit.yml/badge.svg)](https://github.com/owner/repo/actions/workflows/audit.yml)
[![Code Quality](https://sonarcloud.io/api/project_badges/measure?project=owner_repo&metric=alert_status)](https://sonarcloud.io/dashboard?id=owner_repo)

## Deployment Status

[![Staging Deploy](https://github.com/owner/repo/actions/workflows/deploy-staging.yml/badge.svg)](https://github.com/owner/repo/actions/workflows/deploy-staging.yml)
[![Production Deploy](https://github.com/owner/repo/actions/workflows/deploy-prod.yml/badge.svg)](https://github.com/owner/repo/actions/workflows/deploy-prod.yml)

ワークフロー バッジは単なるステータス インジケーターではなく、信頼を構築し、透明性を提供し、コード品質へのコミットメントを示すコミュニケーション ツールです。 それらを戦略的に使用して、プロの有益なプロジェクトプレゼンテーションを作成します。

バッジのドキュメントについては、「 ワークフローステータスバッジの追加」を参照してください。