Skip to content

Workflows

Jump to bottom
github-actions[bot] edited this page Apr 18, 2026 · 156 revisions

🛠️ Workflow Documentation

This page explains the GitHub Actions workflows and composite action that generate and publish the Bookie Reports Dashboard.

1. Diago Verification

  • Purpose: Runs the Diago tool on the main branch, commits reports to EMC/.
  • Triggers: Push to main, manual dispatch, or weekly on Sundays at midnight UTC.
  • Outputs: Reports in EMC/report.md, EMC/report.json, and EMC/latest_report.md.

2. Update Configs

  • Purpose: Runs the Diago tool on the secondary branch, commits to secondary, and creates a pull request to main.
  • Triggers: Push to secondary, daily at 01:00 UTC, or manual dispatch.
  • Outputs: Updated reports in EMC/ and a pull request with diff comments.

3. Publish to Wiki

  • Purpose: Updates the wiki with the latest report, historical archives, and this documentation using a composite action.
  • Triggers: Changes to EMC/ on any branch or manual dispatch.
  • Composite Action: The wiki publishing logic is encapsulated in a reusable composite action (entrypoint.sh).
  • Outputs:
    • Home.md: Dashboard with links to latest and historical reports.
    • Latest_Report.md: Summary of the latest report.
    • history/YYYY-MM-DD_HH-MM/: Archived reports and JSON data.
    • Workflows.md: This documentation page.

🔧 Prerequisites

  • GitHub Token: Required for repository, pull request, and wiki access (set as GH_TOKEN).
  • Go Application: main.go with support for --mode=auto and --mode=fetch.
  • Wiki Enabled: Repository wiki must be enabled.
  • Bookies File: bookies.txt for Diago input.
  • Composite Action: The publish-wiki action must be configured in the repository.

📋 Composite Action Details

The publish-wiki composite action (entrypoint.sh) handles wiki updates, ensuring consistent formatting and navigation across pages.

  • Inputs:
    • OUTPUT_DIR: Directory containing report files (default: EMC).
    • GH_TOKEN: GitHub token for wiki access.
  • Outputs: Updated wiki pages (Home.md, Latest_Report.md, Workflows.md, and historical archives).

Generated by GitHub Actions | Last updated: 2026-04-18_03-45

Clone this wiki locally