Skip to content

docs: add EXAMPLES.md and consolidate CI workflow#7

Merged
machado144 merged 3 commits into
mainfrom
docs/examples-and-ci-cleanup
Apr 4, 2026
Merged

docs: add EXAMPLES.md and consolidate CI workflow#7
machado144 merged 3 commits into
mainfrom
docs/examples-and-ci-cleanup

Conversation

@machado144

@machado144 machado144 commented Apr 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add EXAMPLES.md with 18 expandable real-world use cases covering CI pipelines, interactive prompts, dev server workflows, secret handling, TUI monitoring, migrations, AI agent scripting, multi-service testing, asciinema recording, local LLM serving, k8s port-forward management, IaC approval gates, ML training monitoring, MCP server lifecycle, SSH tunnel management, E2E testing, multi-agent AI orchestration, and Docker build matrices
  • Add quick-reference patterns table in EXAMPLES.md
  • Add reference link to EXAMPLES.md in README under the Usage section
  • Remove redundant ci.yml — the test/build/vuln-check job was duplicated in pr.yml
  • Remove push trigger entirely — all validations run only on pull requests
  • Allow *.gif in .structlint.yaml to fix validation failure on docs/demo.gif

Test plan

  • Verify EXAMPLES.md renders correctly on GitHub (expandable <details> blocks)
  • Verify README link to EXAMPLES.md works
  • Confirm PR workflow triggers correctly on pull_request events
  • Confirm structlint passes with *.gif allowed

- Add EXAMPLES.md with expandable real-world use cases (CI pipelines,
  interactive prompts, TUI monitoring, secret handling, dev workflows,
  asciinema recording, multi-service testing, AI agent scripting)
- Add reference to EXAMPLES.md in README
- Remove redundant ci.yml — merge push-to-main trigger into pr.yml
  with conditional guards so PR-only jobs (title, e2e, review, validate)
  skip on push events
@github-actions

github-actions Bot commented Apr 4, 2026

Copy link
Copy Markdown

StructLint — All checks passed

62 rules validated against .structlint.yaml. No violations found.

View full run · Powered by StructLint

@github-actions github-actions Bot 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.

Core Changes

  • Removed the ci.yml GitHub Actions workflow.
  • Consolidated CI/CD logic, as the removed workflow's steps (tests, build, vulnerability check) are now handled by the pr.yml workflow.
  • Eliminated push triggers for CI, ensuring all validations run exclusively on pull requests.

Verdict

Approve: The change removes a redundant CI workflow, streamlining the CI/CD setup without losing critical validation steps, as confirmed by the PR description.


Code review performed by GEMINI - gemini-2.5-flash.

Add 9 new examples (local LLMs, k8s port-forwards, IaC approval
gates, ML training, MCP servers, SSH tunnels, E2E testing,
multi-agent AI, Docker build matrix). Allow *.gif in structlint
to fix validation failure on docs/demo.gif.

@github-actions github-actions Bot 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.

Core Changes

  • Consolidated CI workflows by removing a redundant ci.yml and ensuring all validations run on pull requests only.
  • Updated .structlint.yaml to allow .gif files, likely to support documentation assets.

Verdict

Approve: The changes are functional, improve CI/CD structure, and do not introduce any bugs or regressions.


Code review performed by GEMINI - gemini-2.5-flash.

@github-actions github-actions Bot 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.

Core Changes

  • Removed a redundant CI workflow (ci.yml) that was triggered on push to main, consolidating all CI checks to run only on pull requests via pr.yml.
  • Updated .structlint.yaml to allow .gif files, resolving a validation error for docs/demo.gif.

Verdict

Approve: The changes simplify the CI setup and correctly address a linter configuration issue without introducing any bugs or regressions.


Code review performed by GEMINI - gemini-2.5-flash.

@machado144 machado144 merged commit bb90fe0 into main Apr 4, 2026
10 checks passed
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.

1 participant