diff --git a/README.md b/README.md index b94f527..a957b7e 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ your own projects. | Report | Project-wide reports | Combine registry sources for one monitored project | ✅ | | Automate | Package health checks | Fail workflows when package standards are not met | 🚧 | | Automate | Workspace policy checks | Evaluate every configured project against policies | ⏳ | -| Automate | GitHub Actions integration | Run Secchi automatically in CI | ⏳ | +| Automate | GitHub Actions integration | Run Secchi automatically in CI | ✅ | | Integrate | Python SDK | Use Secchi from Python applications and scripts | ⏳ | | Integrate | MCP Server | Let AI assistants query package intelligence | ✅ | | Explore | Ecosystem adapters | Support PyPI, npm, crates.io, Homebrew, Go Modules, and CRAN | ✅ | @@ -143,6 +143,19 @@ package inspection, cross-registry search, configured project reports, and health policy checks. It reuses the same cached intelligence pipeline as the CLI, dashboard, and report commands. +## GitHub Actions + +Secchi is available on the GitHub Marketplace as +[Secchi Package Intelligence](https://github.com/marketplace/actions/secchi-package-intelligence). +Use it to run package intelligence in CI and publish Markdown reports to the +Actions job summary or a pull request comment. + +```yaml +- uses: kannandreams/secchi-action@v1 + with: + package: pypi:duckdb +``` + ## Use Secchi with MCP Secchi can be added to an MCP-compatible coding agent or desktop client as a diff --git a/docs/github-actions.md b/docs/github-actions.md new file mode 100644 index 0000000..ed99782 --- /dev/null +++ b/docs/github-actions.md @@ -0,0 +1,96 @@ +# GitHub Actions + +Secchi is available as a GitHub Marketplace Action: + +[Secchi Package Intelligence](https://github.com/marketplace/actions/secchi-package-intelligence) + +Use it when you want package intelligence to run automatically in CI and appear +in the GitHub Actions job summary or, for pull request workflows, as a PR +comment. + +## Run after merges to `main` + +For a simple post-merge scan of the published Secchi package: + +```yaml +name: secchi-scan + +"on": + push: + branches: [main] + workflow_dispatch: + +permissions: + contents: read + issues: write + +jobs: + secchi: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + + - uses: kannandreams/secchi-action@v1 + with: + package: pypi:secchi + comment: "false" +``` + +On `push` events there is no pull request to comment on, so `comment: "false"` +keeps the run focused on the Actions job summary. + +## Comment on pull requests + +For dependency-review style feedback on PRs: + +```yaml +name: secchi-scan + +"on": + pull_request: + types: [opened, synchronize, reopened] + +permissions: + contents: read + issues: write + +jobs: + secchi: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + + - uses: kannandreams/secchi-action@v1 + with: + package: pypi:duckdb +``` + +The action creates or updates a single Secchi PR comment. Re-runs update the +existing comment instead of creating a new one. + +## Workspace project reports + +If a repository has a `secchi.toml`, run a configured project report: + +```yaml +- uses: kannandreams/secchi-action@v1 + with: + config: secchi.toml + project: duckdb +``` + +This calls `secchi report --format md` and publishes the Markdown report. + +## Permissions and forked PRs + +PR comments require: + +```yaml +permissions: + contents: read + issues: write +``` + +GitHub may make `GITHUB_TOKEN` read-only for pull requests from forks depending +on repository settings. In that case, the Secchi report still appears in the +job summary, but the PR comment may be skipped or fail. diff --git a/mkdocs.yml b/mkdocs.yml index 4051459..3eb1a61 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,6 +39,7 @@ nav: - Dashboard metrics: metrics.md - Workspace: workspace.md - Reports: reports.md + - GitHub Actions: github-actions.md - MCP and agents: mcp.md - Development: development.md - Contributing: contributing.md diff --git a/pyproject.toml b/pyproject.toml index 6cbc9ca..e428660 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,6 +25,12 @@ dependencies = [ secchi = "secchi.cli:main" secchi-mcp = "secchi.mcp_server:main" +[project.urls] +Homepage = "https://secchi.dev" +Documentation = "https://secchi.dev/getting-started/" +Repository = "https://github.com/kannandreams/secchi" +Issues = "https://github.com/kannandreams/secchi/issues" + [build-system] requires = ["hatchling", "hatch-vcs"] build-backend = "hatchling.build" diff --git a/secchi-secchi-package-2026-08-13.md b/secchi-secchi-package-2026-08-13.md new file mode 100644 index 0000000..6194fcd --- /dev/null +++ b/secchi-secchi-package-2026-08-13.md @@ -0,0 +1,36 @@ +# secchi + +Registry: `pypi` + +Beautiful TUI dashboard to monitor packages across PyPI, crates.io, and npm + +## Overview + +| Signal | Value | +| --- | --- | +| Health score | 45 / 100 (D) | +| Latest version | 0.1.4 | +| Downloads (30d) | 554 | +| Adoption change | No baseline available | +| GitHub stars | 0 | +| Reverse dependencies | — | +| Security advisories | 0 affecting latest version | + +## Security advisories + +No known advisories affect the latest version. + + +## Health breakdown + +| Category | Score | +| --- | --- | +| Maintenance | 20 / 20 | +| Community | 0 / 15 | +| Documentation | 0 / 15 | +| Releases | 9 / 15 | +| Security | 16 / 20 | +| Testing | 0 / 15 | + + +Generated by [Secchi](https://github.com/kannandreams/secchi)