Skip to content

[aw-compat] Common error: non-gh-aw .md documentation files in .github/workflows/ cause "no frontmatter found" #27312

@github-actions

Description

@github-actions

Problem

Two repositories fail compilation because they contain plain documentation .md files in .github/workflows/ that have no gh-aw frontmatter:

labeler.md: no frontmatter found
✗ compilation failed

Affected repos (2 of 20 in today's audit):

Root Cause

Both repos use dotnet/issue-labeler and place a labeler.md README in .github/workflows/ to document the setup. This file is pure documentation — it describes other .yml workflow files — but contains no gh-aw frontmatter.

The gh-aw compiler scans all .md files in .github/workflows/ and attempts to compile them, causing the build to fail hard.

Impact

  • gh aw fix does not fix this: the fix pass exits 0 but the re-compile still fails
  • Any workflow that passes compilation is blocked from deploying because the overall compile returns non-zero
  • This is likely a widespread pattern across repos that use both gh-aw and other GitHub Actions tooling

Possible Mitigations

Option A — User-side: Users should rename or relocate documentation files:

  • Rename to labeler.README.md (no .md extension in compiled glob)
  • Move to .github/docs/ or project root

Option B — Compiler-side (recommended): Emit a clear warning rather than a hard error for .md files without frontmatter, to allow mixed-purpose directories. Alternatively, respect a .gh-aw-ignore file or frontmatter-less files as opt-outs.

Option C — Fix codemod: gh aw fix could detect frontmatter-less .md files in .github/workflows/ and offer to add a skip: true frontmatter stub, or rename them.

Example File Content

# Issue-Labeler Workflows

This repository uses actions from dotnet/issue-labeler to predict area labels...
[No gh-aw frontmatter present]

Recommendation

Implement Option B as the lowest-friction fix: treat missing frontmatter as a warning (or skip) rather than a compile error. This matches the principle of least surprise for users who use .github/workflows/ as a general workflows directory.

References:

Generated by Daily AW Cross-Repo Compile Check · ● 642.8K ·

  • expires on Apr 27, 2026, 11:16 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions