Skip to content

ci: organize example workflows and status badges#241

Merged
fahimfaisaal merged 1 commit into
mainfrom
ci/example-status-badges
Jul 19, 2026
Merged

ci: organize example workflows and status badges#241
fahimfaisaal merged 1 commit into
mainfrom
ci/example-status-badges

Conversation

@fahimfaisaal

@fahimfaisaal fahimfaisaal commented Jul 19, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Summary

  • rename example workflows and group their display names under Examples:
  • add workflow status badges to the examples overview and topic pages
  • add the release status badge to the README

Validation

  • task format:check
  • pnpm build in docs/
  • bash -n scripts/act-examples.sh
  • verified reusable workflow references and removed stale filenames

Summary by CodeRabbit

  • Documentation

    • Added workflow status badges across example documentation pages.
    • Expanded live dashboard listings to include Go, JavaScript, and Rust examples.
    • Updated workflow references and setup instructions to reflect the streamlined naming.

  • Chores

    • Standardized example workflow names and references.
    • Added a release workflow badge to the README.
    • Updated local example automation to use the renamed workflows.

@coderabbitai

coderabbitai Bot commented Jul 19, 2026 •
edited
Loading

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b32b3ed8-c52b-4002-95f0-ee9f72df4d80

📥 Commits

Reviewing files that changed from the base of the PR and between 78a8b50 and ae8e026.

📒 Files selected for processing (18)
  • .github/workflows/comparisons-examples.yml
  • .github/workflows/github-legends.yml
  • .github/workflows/go-examples.yml
  • .github/workflows/javascript-examples.yml
  • .github/workflows/math-and-3d-examples.yml
  • .github/workflows/release.yml
  • .github/workflows/rust-examples.yml
  • .github/workflows/tabular-data-examples.yml
  • README.md
  • docs/src/content/docs/examples/benchmarks.mdx
  • docs/src/content/docs/examples/comparisons.mdx
  • docs/src/content/docs/examples/github-legends.mdx
  • docs/src/content/docs/examples/index.mdx
  • docs/src/content/docs/examples/math-and-3d.mdx
  • docs/src/content/docs/examples/tabular-data.mdx
  • examples/README.MD
  • examples/csv/README.md
  • scripts/act-examples.sh
📝 Walkthrough

Walkthrough

Example workflows are renamed with consistent display names and updated reusable-workflow paths. Documentation, badges, example references, and the local example runner now point to the renamed workflow files.

Changes

Example workflow naming

Layer / File(s) Summary
Workflow names and release wiring
.github/workflows/*-examples.yml, .github/workflows/github-legends.yml, .github/workflows/release.yml		 Workflow display names now use the Examples: prefix, and release jobs reference the renamed reusable workflows.
Local workflow selection
scripts/act-examples.sh		 The example runner maps topic slugs and GitHub Legends to the renamed workflow files.
Documentation links and status visibility
README.md, docs/src/content/docs/examples/*, examples/README.MD, examples/csv/README.md		 Workflow links, setup instructions, dashboard tables, and GitHub Actions status badges are updated to match the renamed workflows.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the workflow renames and added status badges.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ci/example-status-badges

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@fahimfaisaal
fahimfaisaal merged commit 71b9aca into main Jul 19, 2026
1 check passed
@fahimfaisaal
fahimfaisaal deleted the ci/example-status-badges branch July 19, 2026 08:44
@coderabbitai coderabbitai Bot mentioned this pull request Jul 21, 2026
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@fahimfaisaal