Skip to content

docs: Pin README status badges to main and ignore build-repair logs - #138

Merged
mpaulosky merged 2 commits into
mainfrom
chore/readme-badge-branch-fixes
Sep 29, 2026
Merged

mpaulosky merged 2 commits into
mainfrom
chore/readme-badge-branch-fixes

Conversation

@mpaulosky

@mpaulosky mpaulosky commented Sep 29, 2026 •

Copy link
Copy Markdown
Owner

Follow-up to #137.

Summary

  • Test badge: point it at test.yml (Test Suite), which runs the tests on every code push to main. It used to point at ci.yml, a build-only gate that never runs on main, so the badge showed the latest PR run.
  • Workflow badges: add ?branch=main to each one and link it to that workflow's main runs, so a failing PR can't turn the README red.
  • xUnit badge: link it to the Test Suite workflow.
  • Lint Markdown: run on pushes to main too, so its badge has a main status. Also fix the bracket spacing yamllint flagged in the trigger block.
  • Log files: ignore build-log.txt, which the build-repair prompt writes, and untrack docs/build-log.txt.
  • Lint Markdown force-push fix: a force-push left github.event.before pointing at a commit the runner could not resolve, so git diff failed with bad object. The step now lints the pushed commit's own files whenever the before commit is missing.

Validation

  • markdownlint-cli2 README.md: 0 issues
  • yamllint .github/workflows/lint-markdown.yml: clean
  • No code changes, so no build or test run.

🤖 Generated with Claude Code

Copilot AI balanced review requested due to automatic review settings September 29, 2026 01:19

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The documentation and workflow changes are consistent, correctly scoped, and introduce no unresolved issues.

Review effort: Balanced
Findings: None

What changed in this PR

Pins README workflow badges to main and removes generated build-repair artifacts.

Changes:

  • Redirects test and workflow badges to current main runs.
  • Enables Markdown linting on main pushes.
  • Ignores and removes generated build logs.
File Description
README.md Updates workflow badge targets and filters.
.github/​workflows/​lint-markdown.yml Adds linting for main pushes.
.gitignore Ignores generated build logs.
docs/​build-log.txt Removes a generated log artifact.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Base automatically changed from chore/readme-status-badges to main September 29, 2026 01:20
- Point the test badge at test.yml (Test Suite), which runs the tests on
  main. The old badge used ci.yml, a build-only gate that never runs on main.
- Add ?branch=main to the workflow badges so a failing PR can't turn the
  README red.
- Link the xUnit badge to the Test Suite workflow.
- Run Lint Markdown on pushes to main so its badge has a main status.
- Ignore build-log.txt (written by the build-repair prompt) and untrack
  docs/build-log.txt.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mpaulosky
mpaulosky force-pushed the chore/readme-badge-branch-fixes branch from 43e819b to 08f8636 Compare September 29, 2026 01:21
@mpaulosky
mpaulosky enabled auto-merge (squash) September 29, 2026 01:24
@github-actions

Copy link
Copy Markdown
Contributor

Test Results Summary

412 tests  ±0   412 ✅ ±0   16s ⏱️ +3s
  8 suites ±0     0 💤 ±0 
  8 files   ±0     0 ❌ ±0 

Results for commit 08f8636. ± Comparison against base commit c240290.

A force-push leaves github.event.before pointing at a commit the runner
cannot resolve, so git diff failed with "bad object". Fall back to the
pushed commit's own files whenever the before commit is missing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mpaulosky
mpaulosky merged commit 86e534f into main Sep 29, 2026
Copilot AI review requested due to automatic review settings September 29, 2026 01:25
@mpaulosky
mpaulosky deleted the chore/readme-badge-branch-fixes branch September 29, 2026 01:26

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The force-push fallback can skip Markdown changes from earlier commits or merge tips.

Review effort: Balanced
Findings: 1 Medium severity

Open (1)

if [[ "${{ github.event.before }}" == "0000000000000000000000000000000000000000" ]]; then
# A new branch has no "before" commit, and a force-push leaves an unreachable one.
if ! git cat-file -e "${{ github.event.before }}^{commit}" 2>/dev/null; then
files=$(git diff-tree --no-commit-id --name-only -r "${{ github.sha }}" -- '*.md')
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