Skip to main content

GitHub Deployments

Track GitHub deployments in Portal

Metadata

Packages

- @backstage-community/plugin-github-deployments

Overview

The GitHub Deployments plugin provides comprehensive visibility into your deployment activities, making it easy to track deployment history and status across your services. This plugin surfaces GitHub deployment information directly within Portal, helping teams monitor deployment success rates, track environment-specific deployments, and maintain awareness of production changes.

Key Features

  • Deployment history overview — displays a chronological list of deployments with status indicators (success, failure, pending) on entity pages.
  • Environment tracking — shows deployment status across different environments (production, staging, development, etc.).
  • Real-time deployment status — provides live updates on ongoing deployments without requiring page refreshes.
  • Deployment metadata — displays detailed information including deployer, timestamp, commit SHA, and deployment environment.
  • Entity mapping — links Portal components to GitHub repositories via annotations (github.com/project-slug).
  • Deployment frequency metrics — helps teams monitor deployment velocity and identify deployment patterns.
  • Integration with GitHub API — leverages native GitHub Deployments API for accurate deployment tracking.
  • Visual status indicators — uses color-coded badges and icons for quick status identification.
  • IDP benefit — centralizes deployment visibility, reduces context-switching, and improves observability across the software delivery lifecycle.

References