Skip to content

Add workflow status badges documentation page#2102

Merged
pelikhan merged 4 commits into
mainfrom
copilot/generate-status-badges-markdown
Oct 22, 2025
Merged

Add workflow status badges documentation page#2102
pelikhan merged 4 commits into
mainfrom
copilot/generate-status-badges-markdown

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Oct 22, 2025

Overview

This PR adds an automated documentation page that displays GitHub Actions status badges for all agentic workflows in the repository.

Changes

New Documentation Page

Created docs/src/content/docs/reference/status.md which displays a simple list of status badges (one per line) for all 42 agentic workflows:

Status page with simplified format

Each badge is clickable and links to the workflow's run history on GitHub Actions.

Implementation

  • Script: scripts/generate-status-badges.js parses all .lock.yml files in .github/workflows/, extracts workflow names using js-yaml, and generates markdown with one badge per line
  • Automation: Integrated as a prebuild step in the docs build process, ensuring badges are always up-to-date
  • Makefile: Added generate-status-badges target and integrated into agent-finish workflow
  • Filtering: Only processes .lock.yml files (agentic workflows), ignoring standard workflow files

Build Integration

The script runs automatically during documentation builds:

# Runs automatically when building docs
cd docs && npm run build

# Can also be run manually
make generate-status-badges

Technical Details

  • Uses GitHub's native status badge syntax
  • Generates a compact 55-line markdown file with simple one-badge-per-line format
  • Workflows are sorted alphabetically for easy navigation
  • Each badge links to the workflow's run history on GitHub Actions
  • Dependencies managed via root package.json (added to .gitignore as build tooling)

Testing

  • ✅ Unit tests pass
  • ✅ Documentation builds successfully with all 42 badges
  • ✅ Page renders correctly in Astro/Starlight with natural badge wrapping
  • ✅ Integration with existing build system verified
Original prompt

Create a nodejs JavaScript script that generates a documentation markdown page containing status badges for all github actions in the repository.

  • page is "status.md"
  • use github builtin actions status badge syntax
  • run script as part of building docs
  • keep it compact
  • only list github actions from lock files (ignore others)

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan pelikhan marked this pull request as ready for review October 22, 2025 07:54
@github-actions
Copy link
Copy Markdown
Contributor

Agentic Changeset Generator triggered by this pull request.

Copilot AI changed the title [WIP] Create documentation page for GitHub Actions status badges Add workflow status badges documentation page Oct 22, 2025
Copilot AI requested a review from pelikhan October 22, 2025 07:57
🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@pelikhan
Copy link
Copy Markdown
Collaborator

@copilot make simpler markdown structure, just one badge per line (let it wrap), no table.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Oct 22, 2025

@copilot make simpler markdown structure, just one badge per line (let it wrap), no table.

Changed to simpler format - one badge per line without table (eaed23f).

Status page with simplified format

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI requested a review from pelikhan October 22, 2025 08:14
@pelikhan pelikhan merged commit ab47faa into main Oct 22, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/generate-status-badges-markdown branch October 22, 2025 08:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants