🐛 Aurora Bug Tracking System

This repository serves as a public, centralized bug tracking system for ALCF Aurora at Argonne National Laboratory. It provides a structured way to document, track, and manage issues related to the system.

Important

The main bug tracking table is available in bugs.md. This comprehensive reference summarizes all currently-known and recently-closed bugs on Aurora.

Other files:

• TODO.md - open questions and potential future changes to this repository setup

Table Format

The two Markdown tables are automatically generated from GitHub issues and contain the following columns:

• Internal ID: GitHub issue number with link
• Description: Issue title
• Vendor ID: Links to related tickets in other bug-tracking systems (vendor JIRA, other GitHub repo, etc.)
• Reproducer Path: Location of code to reproduce the bug (e.g. on /lus/flare/ or a URL)
• PoC: Point of Contact
• Status: Current status of the bug (final status for closed issues)
• Priority: 🚨 if marked as priority
• ETA: Expected resolution date
• Date Opened: When the issue was created
• Last Updated/Closed Date: When the issue was last modified (changed title or edited text body for open issues) or closed (for closed issues). Note, a new/deleted/edited comment on an open Issue will also modify its "Last Updated" date, but deleting a comment will never rollback the date.

This content is parsed from our current Bug Report Form template; changes to that template require changing the GitHub Action parser logic.

Tip

Multiline fields will be joined by spaces when parsed. For fields like "Point of Contact" and "Vendor ID" that may have multiple entries, it is best to join them with commas on a single line. Markdown table cells do not natively support multiline strings

Warning

Issues opened via the Blank issue template will likely break this auto-parsing process (and likely several rows of the bugs.md table). Add the do-not-parse Label to any incorrectly-formatted Issues, meta-Issues about this repo, or in general for Issues that shouldn't be summarized in the Markdown table

Important

Any extra content at the end of the Issue will be added to the final header's column in the table, i.e. "ETA". Best to add content that doesn't match the template in the "Details" section (not parsed), or in a follow-up comment on the Issue

Auto-Generation Process

The bug tracking table is automatically synchronized using GitHub Actions. The synchronization runs automatically whenever an Issue is opened and/or edited, and every night at 9am UTC. You can also trigger it manually:

• Through the GitHub Actions Web UI
• Via command line: gh workflow run "Sync issues to table"

To monitor a summary of the last 20 submitted workflow runs from the command line:

GH_FORCE_TTY=100% watch -c gh run list # --workflow=sync-issues-to-table.yml

This assumes that your watch installation and terminal support the rich-formatted, color-enabled output from gh (e.g. procps-ng watch on Linux, not BSD watch on macOS).

To watch a more detailed breakdown (only while it is executing) of most recently-launched workflow run:

gh run watch -i 1 $(gh run list --workflow=sync-issues-to-table.yml --json databaseId --jq '.[0].databaseId')

To view a summary of the most recently-launched workflow run in your browser:

gh run view $(gh run list --workflow=sync-issues-to-table.yml --json databaseId --jq '.[0].databaseId') -w

License

This project is maintained by Argonne National Laboratory. Contact repository maintainers for usage guidelines.