repo-dive 0.9.0 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -32,6 +32,7 @@ See [docs/specs](docs/specs/README.md) for the architecture and [docs/research/p
32
32
  Live dashboards for a few popular repositories, produced by running the tool on their full history:
33
33
 
34
34
  - [curl](https://kachkaev.github.io/repo-dive/examples/curl/) (C, since 1999)
35
+ - [effect](https://kachkaev.github.io/repo-dive/examples/effect/) (TypeScript, since 2020)
35
36
  - [ollama](https://kachkaev.github.io/repo-dive/examples/ollama/) (Go, since 2023)
36
37
  - [prettier](https://kachkaev.github.io/repo-dive/examples/prettier/) (JavaScript, since 2016)
37
38
  - [react](https://kachkaev.github.io/repo-dive/examples/react/) (JavaScript, since 2013)
@@ -121,6 +122,37 @@ The dashboard badges bots and AI agents, listing them apart from humans.
121
122
  Apart from `catalog`, which every command needs, the config is read by `index`.
122
123
  See [docs/specs/07-config.md](docs/specs/07-config.md) for details.
123
124
 
125
+ ## GitHub Action
126
+
127
+ The repository doubles as a composite GitHub Action, so any project can produce and refresh its report right in CI instead of on somebody's laptop.
128
+ Commit a workflow like this to the repository you want to analyze:
129
+
130
+ ```yaml
131
+ name: repo-dive
132
+
133
+ on:
134
+ schedule:
135
+ - cron: "27 5 * * 1" # weekly
136
+ workflow_dispatch:
137
+
138
+ permissions:
139
+ contents: read
140
+
141
+ jobs:
142
+ report:
143
+ runs-on: ubuntu-latest
144
+ steps:
145
+ - uses: actions/checkout@v7
146
+ with:
147
+ fetch-depth: 0 # the whole history is the whole point
148
+
149
+ - uses: kachkaev/repo-dive@main
150
+ ```
151
+
152
+ Every run restores the catalog from the Actions cache, scans only the commits that are new since the previous run and uploads the self-contained report as an artifact, viewable straight from the run page.
153
+ Long first scans are banked too: when the scan hits its time limit, the progress is cached and the next run resumes where this one stopped.
154
+ See [docs/github-action.md](docs/github-action.md) for all inputs, publishing the report to GitHub Pages and analyzing repositories other than the workflow's own.
155
+
124
156
  ## AI agents (MCP)
125
157
 
126
158
  `repo-dive mcp` serves the metrics cube over the Model Context Protocol on stdio, so an agent can explore a repository's history by asking SQL questions.