Skip to content

ci: add GitHub Actions workflow and CI badges#1

Merged
MSeyyidDev merged 1 commit into
mainfrom
chore/add-ci
May 10, 2026
Merged

ci: add GitHub Actions workflow and CI badges#1
MSeyyidDev merged 1 commit into
mainfrom
chore/add-ci

Conversation

@MSeyyidDev
Copy link
Copy Markdown
Owner

Summary

Adds a GitHub Actions workflow that runs the existing test suite on every push and pull request, plus status badges in the README.

Technical details

  • New workflow at .github/workflows/ci.yml.
  • Installs the package with pip install -e ., runs pytest, then smoke-tests the CLI (generate +
    eport).
  • pip / npm dependencies are cached for fast subsequent runs.
  • Uses the auto-provided GITHUB_TOKEN only; no custom secrets required.
  • Read-only permissions: contents: read to follow least-privilege defaults.

Testing notes

  • The workflow runs the same suite that passes locally (60 pytest tests).
  • Triggers on push to main and on every PR targeting main.
  • Manually re-runnable from the Actions tab.

Next steps

  • Add a coverage report (e.g. pytest --cov + Codecov) and a coverage badge.
  • Wire a release / deploy job once a hosting target is chosen.
  • Add Dependabot config to keep dependencies fresh.

@MSeyyidDev MSeyyidDev merged commit c477d64 into main May 10, 2026
@MSeyyidDev MSeyyidDev deleted the chore/add-ci branch May 10, 2026 17:18
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