@mcptoolshop/housekeeping 1.3.1 → 1.5.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/CHANGELOG.md +69 -0
- package/README.es.md +171 -81
- package/README.fr.md +161 -76
- package/README.hi.md +123 -67
- package/README.it.md +184 -81
- package/README.ja.md +116 -72
- package/README.md +91 -23
- package/README.pt-BR.md +179 -93
- package/README.zh.md +122 -75
- package/housekeeping.config.example.json +3 -1
- package/package.json +1 -1
- package/rules/atlas-map.md +6 -1
- package/rules/github-actions.md +7 -3
- package/src/analyze.mjs +148 -41
- package/src/cli.mjs +85 -2
- package/src/collect.mjs +78 -5
- package/src/config.mjs +22 -4
- package/src/load.mjs +62 -6
- package/src/report.mjs +13 -9
- package/src/schema.sql +35 -1
- package/src/workflow-risks.mjs +160 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,75 @@
|
|
|
3
3
|
All notable changes to this project are recorded here.
|
|
4
4
|
The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
|
5
5
|
|
|
6
|
+
## [1.5.0] - 2026-11-07
|
|
7
|
+
|
|
8
|
+
### Added
|
|
9
|
+
|
|
10
|
+
- A branch pass (collector 1.6.0): every branch of every non-archived
|
|
11
|
+
repository, the pull requests it was the head of, and the repository's
|
|
12
|
+
"automatically delete head branches" setting, in the `branch` and
|
|
13
|
+
`repo_branches` tables. A merged branch whose tip moved after the merge is
|
|
14
|
+
`merged_moved`, not `merged`: those commits cannot be restored from the pull
|
|
15
|
+
request page. About 1 GraphQL point per repository.
|
|
16
|
+
- `hk branches [repo]`: branches by state.
|
|
17
|
+
- `hk watch [repo ...]` and the `watch` config key: open pull requests, open
|
|
18
|
+
alerts and branches for a short list of repositories.
|
|
19
|
+
|
|
20
|
+
### Fixed
|
|
21
|
+
|
|
22
|
+
- `CI_PAGES_NOT_ENABLED` no longer fires on a private repository whose deploy
|
|
23
|
+
job is gated to public repositories (`if: !github.event.repository.private`,
|
|
24
|
+
or a job it needs is). That job is skipped, so Pages being off refuses
|
|
25
|
+
nothing. A gate joined with `||`, or one it cannot read, still counts.
|
|
26
|
+
- Scoped npm package names are encoded properly when the collector looks them up
|
|
27
|
+
on the registry (`encodeURIComponent`, not a single slash swap).
|
|
28
|
+
- The landing page and handbook dependencies were updated to clear known
|
|
29
|
+
advisories (`postcss-selector-parser`, `sharp`, `source-map-js`,
|
|
30
|
+
`http-cache-semantics`, `smol-toml`).
|
|
31
|
+
|
|
32
|
+
### Security
|
|
33
|
+
|
|
34
|
+
- Lockfile refresh for the MCP server's dependencies: @hono/node-server 2.1.6 and hono 4.13.17 (GHSA-rmxm-3fg6-px4f, GHSA-5r4p-p66f-jhc7), body-parser 2.4.0 (GHSA-27r3-jxmh-p828, high), fast-uri 3.1.9 (GHSA-w74x-v6f9-j3xg, GHSA-xhq7-xmqj-769h, GHSA-wjr9-j795-jxcr, GHSA-333x-w4r6-6crp), qs 6.17.1 (GHSA-6pq8-jhm2-2vcw). Installs from npm resolve within the same ranges.
|
|
35
|
+
|
|
36
|
+
## [1.4.0] - 2026-10-01
|
|
37
|
+
|
|
38
|
+
### Added
|
|
39
|
+
|
|
40
|
+
- The README and handbook show how to run one AI agent over a whole organization
|
|
41
|
+
through `hk-mcp`, and how housekeeping and Atlas work together.
|
|
42
|
+
- `homeOrgs` in the config: the organizations whose projects count as your
|
|
43
|
+
own. Unset, it is the swept organization.
|
|
44
|
+
|
|
45
|
+
### Changed
|
|
46
|
+
|
|
47
|
+
- A fork of another organization's project is exempt from `ATLAS_MAP_MISSING`
|
|
48
|
+
and `ATLAS_CHECK_NOT_IN_CI`, as the rule now says: its workflows are the
|
|
49
|
+
upstream's. The collector reads each fork's parent owner (collector 1.5.0);
|
|
50
|
+
a fork whose parent was not read keeps the rule.
|
|
51
|
+
|
|
52
|
+
### Fixed
|
|
53
|
+
|
|
54
|
+
- `ATLAS_ENGINE_BEHIND` measures maps and CI pins against the fleet's own pin
|
|
55
|
+
(the `atlas check` version most repositories pin), not npm's latest. A new
|
|
56
|
+
Atlas release on npm no longer makes every map "behind" before a pin-bump
|
|
57
|
+
wave moves the fleet to it. Snapshots taken before the first wave ended keep
|
|
58
|
+
the npm comparison they were reported with.
|
|
59
|
+
- `CI_REQUIRED_CHECK_GATED` names the repair: a workflow that emits a required
|
|
60
|
+
check takes no paths filter on `pull_request`; `push` stays gated.
|
|
61
|
+
- `PRE_1_0` is retired. It filed every package below 1.0.0 as a defect, but
|
|
62
|
+
1.0.0 is meant to say the product is 1.0, and unfinished work stays 0.x.
|
|
63
|
+
- `WF_SCHEDULED` fires only when a scheduled workflow fails a condition of the
|
|
64
|
+
scheduled-workflow rule: weekly or slower, Linux runners, `timeout-minutes`, a
|
|
65
|
+
`concurrency` block, no push to the branch it checked out, and
|
|
66
|
+
`workflow_dispatch`. It used to fire on every schedule. A workflow that fails
|
|
67
|
+
only on cadence is `low`, since the rule allows a faster schedule with a stated
|
|
68
|
+
reason. New column `workflow.schedule_gaps`; rebuild the database.
|
|
69
|
+
- `CI_REQUIRED_CHECK_GATED` no longer counts a conflicting pull request.
|
|
70
|
+
GitHub runs no `pull_request` workflow on a PR with conflicts, so a
|
|
71
|
+
required check missing from it says nothing about the paths filter, and the
|
|
72
|
+
repair is a rebase (which `PR_CONFLICTED` reports), not a trigger change. A
|
|
73
|
+
conflicted PR that also misses the paths filter is reported once rebased.
|
|
74
|
+
|
|
6
75
|
## [1.3.1] - 2026-09-30
|
|
7
76
|
|
|
8
77
|
### Fixed
|
package/README.es.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<a href="README.ja.md">日本語</a> | <a href="README.zh.md">中文</a> | <a href="README.md">
|
|
2
|
+
<a href="README.md">English</a> | <a href="README.ja.md">日本語</a> | <a href="README.zh.md">中文</a> | <a href="README.es.md">Español</a> | <a href="README.fr.md">Français</a> | <a href="README.hi.md">हिन्दी</a> | <a href="README.it.md">Italiano</a> | <a href="README.pt-BR.md">Português (BR)</a>
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
<p align="center">
|
|
@@ -10,7 +10,8 @@
|
|
|
10
10
|
|
|
11
11
|
<p align="center">
|
|
12
12
|
An operational-health warehouse for a GitHub organization.<br>
|
|
13
|
-
One sweep, one SQLite database, findings you can argue with
|
|
13
|
+
One sweep, one SQLite database, findings you can argue with,<br>
|
|
14
|
+
and the whole-organization view an AI agent needs to coordinate every repository.
|
|
14
15
|
</p>
|
|
15
16
|
|
|
16
17
|
<p align="center">
|
|
@@ -20,40 +21,125 @@
|
|
|
20
21
|
<a href="https://mcp-tool-shop-org.github.io/housekeeping/handbook/"><img src="https://img.shields.io/badge/Handbook-read-blue" alt="Handbook" /></a>
|
|
21
22
|
</p>
|
|
22
23
|
|
|
23
|
-
Una sola ejecución recopila el estado de CI de cada repositorio, los problemas abiertos y las solicitudes de
|
|
24
|
+
Una sola ejecución recopila el estado de CI de cada repositorio, los problemas abiertos y las solicitudes de extracción,
|
|
25
|
+
lanzamientos, etiquetas de versión, archivos de flujo de trabajo, protección de ramas, alertas de seguridad,
|
|
26
|
+
archivos de bloqueo y la facturación de Actions en SQLite, y luego realiza una auditoría de todo esto en función de las
|
|
27
|
+
reglas establecidas.
|
|
24
28
|
|
|
25
29
|
Responde, para toda la organización a la vez:
|
|
26
30
|
|
|
27
|
-
- ¿Cuáles son las ramas predeterminadas que
|
|
28
|
-
- ¿Cuáles son las solicitudes de
|
|
29
|
-
- ¿Cuáles son
|
|
31
|
+
- ¿Cuáles son las ramas predeterminadas que están en rojo y se trata de una rama principal defectuosa o de un historial obsoleto?
|
|
32
|
+
- ¿Cuáles son las solicitudes de extracción que nunca se pueden fusionar, porque una comprobación requerida que no emite nada las está bloqueando?
|
|
33
|
+
- ¿Cuáles son los despliegues que los propios ajustes del repositorio rechazan?
|
|
30
34
|
- ¿Dónde han divergido `package.json`, las etiquetas de Git y el registro de npm?
|
|
31
|
-
- ¿Cuáles son los flujos de trabajo que infringen las reglas de
|
|
32
|
-
- ¿
|
|
35
|
+
- ¿Cuáles son los flujos de trabajo que infringen las reglas de costos de Actions, cuánto costaron y qué trabajos los utilizaron?
|
|
36
|
+
- ¿Qué repositorios contienen avisos que el recuento de alertas de GitHub no detecta?
|
|
37
|
+
|
|
38
|
+
Es un instrumento de auditoría, no un corrector. Lee GitHub y no cambia nada.
|
|
39
|
+
|
|
40
|
+
## Un agente para cada repositorio
|
|
41
|
+
|
|
42
|
+
Una organización con docenas de repositorios no tiene un único lugar donde se almacene su
|
|
43
|
+
estado. housekeeping es ese lugar, y su servidor MCP, `hk-mcp`, se lo proporciona a un agente de IA. Con él, un agente puede actuar como coordinador para toda la
|
|
44
|
+
organización:
|
|
45
|
+
|
|
46
|
+
1. **Ejecución.** `hk refresh` toma una instantánea de cada repositorio.
|
|
47
|
+
2. **Clasificación.** El agente pregunta qué está en rojo, qué está bloqueado y qué ha empeorado,
|
|
48
|
+
y obtiene respuestas que ya distinguen una rama principal defectuosa de un historial obsoleto, y
|
|
49
|
+
una solicitud de extracción bloqueada de una solicitud en conflicto.
|
|
50
|
+
3. **Planificación de una ola.** Una consulta de `hk_sql` encuentra todos los repositorios con la misma
|
|
51
|
+
estructura, por lo que una corrección se convierte en una solicitud de extracción por repositorio en lugar de una búsqueda.
|
|
52
|
+
4. **Realización del trabajo.** housekeeping nunca escribe. El agente abre solicitudes de extracción
|
|
53
|
+
con sus propias herramientas, bajo sus propios permisos y con su revisión.
|
|
54
|
+
5. **Verificación.** Ejecución de nuevo. El hallazgo desaparece o no, y el cambio
|
|
55
|
+
entre dos instantáneas es una consulta.
|
|
56
|
+
|
|
57
|
+
Preguntas a las que un agente responde en una o dos llamadas:
|
|
58
|
+
|
|
59
|
+
- ¿Cuáles son las ramas predeterminadas que están en rojo y qué trabajo y paso fallaron?
|
|
60
|
+
- ¿Cuáles son las solicitudes de extracción que nunca se pueden fusionar y es el desencadenador o un conflicto el culpable?
|
|
61
|
+
- ¿Qué repositorios contienen un aviso de producción para el que GitHub no muestra ninguna alerta?
|
|
62
|
+
- ¿Qué flujos de trabajo programados infringen las reglas para las programaciones y cómo?
|
|
63
|
+
- ¿Cuánto costaron Actions y qué trabajo lo utilizó?
|
|
64
|
+
- ¿Qué ha cambiado desde la última ejecución?
|
|
65
|
+
|
|
66
|
+
| Herramienta | Lo que responde |
|
|
67
|
+
|---|---|
|
|
68
|
+
| `hk_summary` | Totales de la ejecución más reciente: repositorios, problemas, solicitudes de extracción, flujos de trabajo, hallazgos. |
|
|
69
|
+
| `hk_findings` | Hallazgos por código, gravedad, categoría o repositorio; recuentos por código cuando no se filtran. El hallazgo de una rama principal en rojo indica el trabajo y el paso que fallaron. |
|
|
70
|
+
| `hk_ci` | Repositorios cuya rama predeterminada está en rojo y los flujos de trabajo que fallaron; también fallan las programaciones, las ramas de solicitudes de extracción que fallan y los repositorios sin CI. |
|
|
71
|
+
| `hk_repo` | Un repositorio completo: hallazgos, flujos de trabajo, solicitudes de extracción y problemas abiertos. |
|
|
72
|
+
| `hk_backlog` | Solicitudes de extracción o problemas abiertos en toda la organización, del más antiguo al más reciente. |
|
|
73
|
+
| `hk_health` | Una puntuación de estado por repositorio, del peor al mejor. |
|
|
74
|
+
| `hk_cost` | Gasto de Actions por repositorio, flujo de trabajo o trabajo, bruto y neto por separado. |
|
|
75
|
+
| `hk_sql` | Una única instrucción de solo lectura `SELECT` o `WITH` contra el almacén. |
|
|
76
|
+
| `hk_schema` | Las tablas y las columnas, para escribir consultas `hk_sql`. |
|
|
77
|
+
|
|
78
|
+
Cada respuesta proviene de la instantánea más reciente, abierta en modo de solo lectura. Una llamada que falla
|
|
79
|
+
devuelve un error estructurado, nunca un rastreo de pila.
|
|
80
|
+
|
|
81
|
+
### Conéctelo
|
|
33
82
|
|
|
34
|
-
|
|
83
|
+
```json
|
|
84
|
+
{
|
|
85
|
+
"mcpServers": {
|
|
86
|
+
"housekeeping": { "command": "hk-mcp", "env": { "HK_HOME": "/path/to/warehouse" } },
|
|
87
|
+
"atlas": { "command": "atlas", "args": ["mcp"] }
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
`HK_HOME` es el directorio desde el que se realiza la ejecución. Desde un clon, utilice
|
|
93
|
+
`"command": "node", "args": ["/path/to/housekeeping/src/mcp.mjs"]`. El segundo
|
|
94
|
+
servidor es [Atlas](https://github.com/dogfood-lab/testing-os/tree/main/packages/atlas),
|
|
95
|
+
que responde al mismo agente sobre un repositorio a la vez (consulte a continuación). En
|
|
96
|
+
Windows, inicie un comando instalado globalmente a través de `cmd /c`.
|
|
97
|
+
|
|
98
|
+
## housekeeping y Atlas
|
|
99
|
+
|
|
100
|
+
[Atlas](https://github.com/dogfood-lab/testing-os/tree/main/packages/atlas)
|
|
101
|
+
(`@dogfood-lab/atlas`) asigna un repositorio: sus partes y sus puertas, lo que significa
|
|
102
|
+
cada flujo de trabajo con lo que ejecuta, publica y despliega. El mapa se confirma
|
|
103
|
+
como `atlas/` y se comprueba en CI. housekeeping es la vista de la organización. Los dos
|
|
104
|
+
están diseñados para funcionar juntos.
|
|
105
|
+
|
|
106
|
+
- **Cada mapa, ejecutado.** Una ejecución lee el mapa confirmado de cada repositorio junto con
|
|
107
|
+
todo lo demás, e informa de qué repositorios no tienen ninguno, qué nunca
|
|
108
|
+
ejecutan `atlas check` y cuáles tienen un motor detrás del que el resto de la
|
|
109
|
+
organización utiliza.
|
|
110
|
+
- **Dónde una ejecución en rojo falló.** Cuando una rama predeterminada está en rojo, el hallazgo indica
|
|
111
|
+
el trabajo y el paso que fallaron y, a través del mapa, el comando que ese paso
|
|
112
|
+
ejecuta, por lo que la reparación comienza en el archivo correcto.
|
|
113
|
+
- **Hechos de despliegue del mapa.** El entorno en el que un trabajo se despliega se toma del
|
|
114
|
+
mapa donde se registra, por lo que ambas herramientas leen un flujo de trabajo de la misma manera.
|
|
115
|
+
- **Advertencias en toda la flota.** Atlas marca un paso del flujo de trabajo que fallará
|
|
116
|
+
antes de ejecutarse, como una herramienta que necesita una versión más reciente del entorno de ejecución que el trabajo
|
|
117
|
+
instala. El informe los enumera para todos los repositorios a la vez.
|
|
118
|
+
|
|
119
|
+
Un agente con ambos servidores pasa de "estos doce repositorios están bloqueados"
|
|
120
|
+
(housekeeping) a "este es el flujo de trabajo, el trabajo y los archivos a los que llegará un cambio" (Atlas), sin abrir cada repositorio manualmente.
|
|
35
121
|
|
|
36
122
|
## Por qué tiene esta forma
|
|
37
123
|
|
|
38
124
|
| Capa | Opción | Razón |
|
|
39
125
|
|---|---|---|
|
|
40
|
-
| Transporte | la CLI `gh` | Ya tiene su token. La herramienta nunca almacena ni solicita
|
|
41
|
-
| Recopilación | GitHub GraphQL,
|
|
42
|
-
| Ejecuciones de Actions | REST | GraphQL no tiene
|
|
43
|
-
|
|
|
44
|
-
| Tarifas de
|
|
126
|
+
| Transporte | la CLI `gh` | Ya tiene su token. La herramienta nunca almacena ni solicita una credencial. |
|
|
127
|
+
| Recopilación | GitHub GraphQL, por páginas | Una consulta devuelve metadatos, problemas abiertos, solicitudes de extracción abiertas, lanzamientos y árboles de archivos para una página de repositorios. Una página que sigue tardando se divide a la mitad y se vuelve a solicitar desde el mismo cursor. |
|
|
128
|
+
| Ejecuciones de Actions | REST | GraphQL no tiene ninguna superficie de Actions. |
|
|
129
|
+
| Costo de Actions | API de facturación más duraciones por trabajo. | La factura indica el repositorio; solo los trabajos indican el flujo de trabajo. Los puntos finales de GitHub's `/timing` devuelven ceros, por lo que la suma por trabajo se reconstruye y luego se concilia con la factura. |
|
|
130
|
+
| Tarifas de ejecución | Leídas de la factura | Una tarifa facturada puede diferir del precio de lista, y una constante en la fuente distorsionaría todos los números. |
|
|
45
131
|
| Almacenamiento | SQLite a través del `node:sqlite` integrado | No hay un paso de compilación nativo. |
|
|
46
|
-
| Fuente de la verdad | `data/snapshots/*.json` |
|
|
47
|
-
| Registro de
|
|
132
|
+
| Fuente de la verdad | `data/snapshots/*.json` | Bruta, comparable y solo para anexar. La base de datos se deriva: `npm run rebuild` la reconstruye sin conexión. |
|
|
133
|
+
| Registro de análisis | `data/sweeps.jsonl` | Una línea por análisis, incluidos los análisis que fallaron y los análisis que no encontraron nada nuevo. |
|
|
48
134
|
|
|
49
135
|
Las instantáneas son inmutables y aditivas, por lo que la desviación entre dos fechas es un `JOIN`.
|
|
50
136
|
|
|
51
137
|
## Requisitos
|
|
52
138
|
|
|
53
139
|
- Node.js 22.5 o posterior.
|
|
54
|
-
- La
|
|
55
|
-
cuenta que puede leer la organización.
|
|
56
|
-
|
|
140
|
+
- La CLI [GitHub](https://cli.github.com/), con inicio de sesión (`gh auth status`) como una
|
|
141
|
+
cuenta que puede leer la organización. Para leer la facturación y las alertas de seguridad,
|
|
142
|
+
se necesitan los permisos correspondientes; un análisis sin ellos registra "no medido" y
|
|
57
143
|
continúa. Nunca registra un permiso faltante como un resultado válido.
|
|
58
144
|
- Windows o Linux. Se desarrolla en Windows y sus pruebas se ejecutan en Linux en
|
|
59
145
|
CI. macOS debería funcionar y no se ha probado.
|
|
@@ -66,9 +152,10 @@ mkdir warehouse && cd warehouse # housekeeping keeps its data here
|
|
|
66
152
|
hk refresh your-org # collect, load, analyze, write reports/AUDIT-<date>.md
|
|
67
153
|
```
|
|
68
154
|
|
|
69
|
-
Para
|
|
155
|
+
Para mantener la configuración entre los análisis, coloque un `housekeeping.config.json` en ese
|
|
156
|
+
directorio (consulte Configuración); luego, `hk refresh` no necesita ningún argumento.
|
|
70
157
|
|
|
71
|
-
O ejecútelo desde una copia, que
|
|
158
|
+
O ejecútelo desde una copia, que mantiene sus datos en la copia:
|
|
72
159
|
|
|
73
160
|
```bash
|
|
74
161
|
git clone https://github.com/mcp-tool-shop-org/housekeeping.git
|
|
@@ -79,7 +166,7 @@ cp housekeeping.config.example.json housekeeping.config.json # then set "org"
|
|
|
79
166
|
hk refresh
|
|
80
167
|
```
|
|
81
168
|
|
|
82
|
-
Luego,
|
|
169
|
+
Luego, consulte:
|
|
83
170
|
|
|
84
171
|
```bash
|
|
85
172
|
hk summary # portfolio totals
|
|
@@ -88,6 +175,8 @@ hk findings # findings grouped by severity and code
|
|
|
88
175
|
hk health # per-repository health score, worst first
|
|
89
176
|
hk repo <name> # one repository in full
|
|
90
177
|
hk prs # every open pull request by age
|
|
178
|
+
hk branches # branches by state: merged, moved after merge, no PR
|
|
179
|
+
hk watch # open PRs, alerts and branches for a short watch list
|
|
91
180
|
hk versions # package.json against git tag against npm
|
|
92
181
|
hk actions # every workflow and its rule flags
|
|
93
182
|
hk cost # Actions cost, gross and net side by side
|
|
@@ -100,14 +189,14 @@ En una copia sin `npm link`, cada `hk <command>` es `node src/cli.mjs <command>`
|
|
|
100
189
|
`npm run rebuild` vuelve a derivar la base de datos y el informe a partir de las instantáneas que ya
|
|
101
190
|
existen en el disco, sin acceso a la red.
|
|
102
191
|
|
|
103
|
-
|
|
192
|
+
Un análisis completo realiza unos pocos cientos de llamadas a la API. No ejecute `refresh` en un bucle.
|
|
104
193
|
|
|
105
194
|
Los resultados se envían a la salida estándar; el progreso y los errores se envían a la salida de error estándar. Cada
|
|
106
|
-
error imprime un código y una pista. Códigos de salida: 0 correcto, 1 error de usuario, 2 error de tiempo de ejecución, 3 parcial (
|
|
195
|
+
error imprime un código y una pista. Códigos de salida: 0 correcto, 1 error de usuario, 2 error de tiempo de ejecución, 3 parcial (el análisis se completó, con lagunas).
|
|
107
196
|
|
|
108
197
|
## Configuración
|
|
109
198
|
|
|
110
|
-
`housekeeping.config.json`, en el directorio
|
|
199
|
+
`housekeeping.config.json`, en el directorio donde funciona la herramienta de limpieza (consulte a continuación):
|
|
111
200
|
|
|
112
201
|
```json
|
|
113
202
|
{
|
|
@@ -116,89 +205,87 @@ error imprime un código y una pista. Códigos de salida: 0 correcto, 1 error de
|
|
|
116
205
|
}
|
|
117
206
|
```
|
|
118
207
|
|
|
119
|
-
- `org` es la organización que se va a analizar. `hk refresh <org>` lo anula. Si no se especifica ninguno
|
|
120
|
-
- `metaRepos` son los repositorios que contienen
|
|
121
|
-
las herramientas
|
|
208
|
+
- `org` es la organización que se va a analizar. `hk refresh <org>` lo anula. Si no se especifica ninguno, un análisis se negará a comenzar.
|
|
209
|
+
- `metaRepos` son los repositorios que contienen la configuración predeterminada de la organización, los activos o
|
|
210
|
+
las herramientas, no un producto comercializado. Están exentos de los hallazgos que solo
|
|
122
211
|
tienen sentido para un producto: falta de archivos README, LICENSE y similares, no tener
|
|
123
212
|
flujos de trabajo y no tener versiones.
|
|
124
213
|
|
|
125
214
|
Un archivo con formato incorrecto es un error, nunca un valor predeterminado silencioso: una clave desconocida, un tipo incorrecto o un JSON dañado detienen la ejecución.
|
|
126
215
|
|
|
127
|
-
Ejecute desde
|
|
128
|
-
en
|
|
129
|
-
lo ejecuta, o en `HK_HOME` cuando
|
|
216
|
+
Ejecute desde una copia, la herramienta de limpieza mantiene `data/`, `reports/` y el archivo de configuración
|
|
217
|
+
en la copia. Ejecute como un paquete instalado, lo mantiene en el directorio desde el que
|
|
218
|
+
lo ejecuta, o en `HK_HOME` cuando esté configurado.
|
|
130
219
|
|
|
131
220
|
Entorno: `HK_HOME` (donde residen los datos, los informes y la configuración),
|
|
132
221
|
`HK_CONFIG` (ruta de configuración), `HK_DB` (ruta de la base de datos), `HK_LOG`
|
|
133
222
|
(`silent`, `normal`, `verbose` o `debug`), `HK_COST_REPOS` y
|
|
134
|
-
`HK_COST_BUDGET` (límites del
|
|
223
|
+
`HK_COST_BUDGET` (límites del costo por trabajo), `GH_PATH` (ruta a `gh`).
|
|
135
224
|
|
|
136
225
|
## Mantenga los datos privados
|
|
137
226
|
|
|
138
|
-
**Lo que escribe
|
|
227
|
+
**Lo que escribe un análisis es confidencial. No confirme `data/` o `reports/` en un
|
|
139
228
|
repositorio público.**
|
|
140
229
|
|
|
141
230
|
Una instantánea registra los nombres y las descripciones de los repositorios privados, cada
|
|
142
|
-
alerta de seguridad abierta con el paquete que menciona, los archivos de flujo de trabajo y la facturación de Actions. GitHub oculta deliberadamente las alertas de seguridad de un repositorio público a
|
|
231
|
+
alerta de seguridad abierta con el paquete que menciona, los archivos de flujo de trabajo y la facturación de Actions. GitHub oculta deliberadamente las alertas de seguridad de un repositorio público a
|
|
232
|
+
todos, excepto a sus mantenedores; una instantánea publicada entregaría esa lista.
|
|
143
233
|
|
|
144
234
|
El `.gitignore` de este repositorio excluye `data/`, `reports/` y
|
|
145
|
-
`housekeeping.config.json`. Para mantener el historial, que es el
|
|
146
|
-
ejecute la herramienta desde un
|
|
147
|
-
|
|
148
|
-
## Servidor MCP
|
|
149
|
-
|
|
150
|
-
`hk-mcp` (o `npm run mcp` en una copia) sirve los datos al programa a través de stdio, por lo que un asistente puede hacer preguntas sin leer una instantánea de varios megabytes:
|
|
151
|
-
|
|
152
|
-
`hk_summary` · `hk_findings` · `hk_ci` · `hk_repo` · `hk_backlog` ·
|
|
153
|
-
`hk_health` · `hk_cost` · `hk_sql` · `hk_schema`
|
|
154
|
-
|
|
155
|
-
```json
|
|
156
|
-
{
|
|
157
|
-
"mcpServers": {
|
|
158
|
-
"housekeeping": { "command": "hk-mcp", "env": { "HK_HOME": "/path/to/warehouse" } }
|
|
159
|
-
}
|
|
160
|
-
}
|
|
161
|
-
```
|
|
162
|
-
|
|
163
|
-
`HK_HOME` es el directorio desde el que se realiza la ejecución. Si utiliza una copia, use `"command": "node", "args": ["/path/to/housekeeping/src/mcp.mjs"]` en su lugar.
|
|
164
|
-
|
|
165
|
-
`hk_sql` acepta una sola instrucción `SELECT` o `WITH` y abre la base de datos
|
|
166
|
-
en modo de solo lectura. Una llamada que falla devuelve un error estructurado, nunca un rastreo de pila.
|
|
235
|
+
`housekeeping.config.json`. Para mantener el historial, que es el propósito de las instantáneas,
|
|
236
|
+
ejecute la herramienta desde un repositorio **privado** y confírmelos allí.
|
|
167
237
|
|
|
168
238
|
## Hallazgos
|
|
169
239
|
|
|
170
|
-
Las reglas se encuentran en `src/analyze.mjs`. Cada una
|
|
240
|
+
Las reglas se encuentran en `src/analyze.mjs`. Cada una cita la regla escrita que aplica,
|
|
171
241
|
por lo que un hallazgo se puede discutir en relación con un estándar y no con el gusto. Las reglas
|
|
172
|
-
que
|
|
242
|
+
que este repositorio incluye se encuentran en [`rules/`](rules/):
|
|
173
243
|
|
|
174
|
-
- [`rules/github-actions.md`](rules/github-actions.md): filtros de
|
|
175
|
-
- [`rules/shipcheck-product-standards.md`](rules/shipcheck-product-standards.md):
|
|
244
|
+
- [`rules/github-actions.md`](rules/github-actions.md): filtros de ruta, ejecutores, tamaño de matriz, límite del archivo de flujo de trabajo, concurrencia.
|
|
245
|
+
- [`rules/shipcheck-product-standards.md`](rules/shipcheck-product-standards.md): CI debe pasar, las puertas de envío, versiones.
|
|
176
246
|
- [`rules/repo-first.md`](rules/repo-first.md): la rama predeterminada.
|
|
177
|
-
- [`rules/atlas-map.md`](rules/atlas-map.md): un mapa
|
|
178
|
-
|
|
179
|
-
Son los estándares de una organización. Si los suyos son diferentes, cambie el archivo de reglas
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
- **
|
|
185
|
-
|
|
186
|
-
- **
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
247
|
+
- [`rules/atlas-map.md`](rules/atlas-map.md): un mapa confirmado de cada repositorio, verificado en CI.
|
|
248
|
+
|
|
249
|
+
Son los estándares de una organización. Si los suyos son diferentes, cambie el archivo de reglas
|
|
250
|
+
y la regla juntos.
|
|
251
|
+
|
|
252
|
+
Las reglas se aseguran de mantener separados los elementos que parecen similares, porque combinarlos produce ruido:
|
|
253
|
+
|
|
254
|
+
- **Una rama predeterminada roja no es una rama de solicitud de extracción roja.** Una rama de Dependabot que falla es una tarea pendiente; una ejecución de `push` que falla en la rama predeterminada es
|
|
255
|
+
un problema. El evento de la ejecución decide cuál es.
|
|
256
|
+
- **El historial no es un problema.** Un flujo de trabajo que se mueve a solo versiones mantiene
|
|
257
|
+
su último fallo de la rama predeterminada para siempre. Un flujo de trabajo eliminado mantiene sus ejecuciones.
|
|
258
|
+
Ninguno es un defecto activo.
|
|
259
|
+
- **Una comprobación requerida que nada puede emitir no es una comprobación que no se ejecutó aquí.**
|
|
260
|
+
Una indica que se elimine el requisito; la otra indica que se corrija el desencadenador. Las reparaciones
|
|
261
|
+
se contradicen entre sí.
|
|
262
|
+
- **Una solicitud de extracción que el desencadenador omitió no es una solicitud de extracción con conflictos.** GitHub no ejecuta
|
|
263
|
+
ningún flujo de trabajo de solicitud de extracción en una solicitud de extracción con conflictos, por lo que su comprobación faltante no dice nada sobre el desencadenador. Esa requiere una rebase.
|
|
264
|
+
- **Una ejecución fallida no es una ejecución cancelada.** `cancel-in-progress` existe para matar
|
|
265
|
+
las ejecuciones obsoletas, por lo que los minutos cancelados suelen ser la regla de concurrencia en funcionamiento.
|
|
266
|
+
- **El costo bruto no es el costo neto.** GitHub mide los repositorios públicos a precio completo y los descuenta a cero. El bruto es la computación real; el neto es el dinero real.
|
|
267
|
+
Nunca se suman.
|
|
268
|
+
- **No medido no es limpio.** Un repositorio GitHub no está analizando informes
|
|
269
|
+
y muestra cero alertas. Un repositorio al que no llegó el paso de costos no tiene una fila de costos. Ambos
|
|
270
|
+
se informan como desconocidos.
|
|
271
|
+
|
|
272
|
+
La gravedad impulsa una puntuación de estado: crítico 40, alto 15, medio 6, bajo 2, informativo 0,
|
|
273
|
+
restados de 100. La puntuación clasifica la atención, no la calidad.
|
|
274
|
+
|
|
275
|
+
El [manual](https://mcp-tool-shop-org.github.io/housekeeping/handbook/)
|
|
276
|
+
enumera todos los resultados, comandos, códigos de error y tablas.
|
|
193
277
|
|
|
194
278
|
## Seguridad
|
|
195
279
|
|
|
196
|
-
- **Solo lectura.** El recopilador emite consultas
|
|
197
|
-
|
|
198
|
-
- **Sin
|
|
280
|
+
- **Solo lectura.** El recopilador emite GraphQL consultas y solicitudes REST `GET`. Nunca
|
|
281
|
+
fusiona, envía, publica, edita o modifica una configuración.
|
|
282
|
+
- **Sin credenciales.** La autenticación es la que ya tiene `gh`. No se escribe nada
|
|
283
|
+
en el disco al respecto.
|
|
284
|
+
- **Sin telemetría.** Los únicos hosts a los que se contacta son la API GitHub, a través de `gh`,
|
|
285
|
+
y el registro de npm, para buscar versiones y avisos.
|
|
199
286
|
- **Lo que almacena** es la parte sensible: consulte "Mantenga los datos privados".
|
|
200
287
|
|
|
201
|
-
Informe
|
|
288
|
+
Informe sobre una vulnerabilidad según se describe en [SECURITY.md](SECURITY.md).
|
|
202
289
|
|
|
203
290
|
## Pruebas
|
|
204
291
|
|
|
@@ -206,7 +293,10 @@ Informe de una vulnerabilidad según lo descrito en [SECURITY.md](SECURITY.md).
|
|
|
206
293
|
npm test
|
|
207
294
|
```
|
|
208
295
|
|
|
209
|
-
Cada regla se prueba en ambas direcciones: la forma que debe activarse y la
|
|
296
|
+
Cada regla se prueba en ambas direcciones: la forma que debe activarse y la
|
|
297
|
+
forma adyacente que no debe activarse. Un verificador independiente vuelve a obtener una muestra de
|
|
298
|
+
resultados de GitHub en tiempo real a través de su propio transporte y omite, de forma evidente, cuando
|
|
299
|
+
no hay base de datos o no hay red.
|
|
210
300
|
|
|
211
301
|
## Licencia
|
|
212
302
|
|