diff --git a/.machine_readable/6a2/ECOSYSTEM.a2ml b/.machine_readable/6a2/ECOSYSTEM.a2ml index a6a529f..0c905f8 100644 --- a/.machine_readable/6a2/ECOSYSTEM.a2ml +++ b/.machine_readable/6a2/ECOSYSTEM.a2ml @@ -26,5 +26,8 @@ projects = [ { name = "gitbot-fleet", repo = "hyperpolymath/gitbot-fleet", relation = "optional-consumer", note = "OikosBot can run as a fleet member via the excluded crates/oikosbot-fleet bridge; the bots/sustainabot/ slot is reserved and separate." }, { name = "affinescript", repo = "hyperpolymath/affinescript", relation = "upstream-toolchain", note = "Provides the AffineScript compiler/stdlib for bot-integration-affine/." }, { name = "verisimdb", repo = "hyperpolymath/verisimdb", relation = "datastore-dependency", note = "Single identity-consonance store (octad of modal witnesses). Its graph + document witnesses subsume the retired ArangoDB, and its semantic witness subsumes the retired Virtuoso/RDF. Runtime client deferred/gated (VeriSimDB v0.1.0). Seed: databases/ontology/eco.ttl." }, - { name = "hpm-*-rsr", repo = "hyperpolymath/hpm-crypto-rsr, hpm-http-client-rsr, hpm-json-rsr, hpm-github-api-rsr", relation = "ffi-dependency", note = "Zig-FFI RSR libraries consumed by bot-integration-affine via the composite libhpm_github_api (crypto/http/json) through AffineScript extern fn." } + { name = "hpm-*-rsr", repo = "hyperpolymath/hpm-crypto-rsr, hpm-http-client-rsr, hpm-json-rsr, hpm-github-api-rsr", relation = "ffi-dependency", note = "Zig-FFI RSR libraries consumed by bot-integration-affine via the composite libhpm_github_api (crypto/http/json) through AffineScript extern fn." }, + { name = "oikosbot-estate", repo = "hyperpolymath/oikosbot-estate", relation = "data-artefact", note = "DATA ONLY, no code, no CI. Versioned Parquet snapshots (runs/repos/releases) plus analysis.json and a rendered report, one directory per collection run, produced by `oikosbot estate`. Kept OUT of this repo deliberately: history stays git history, and OikosBot never silently measures a corpus containing itself. Named oikosbot-estate, not oikos-*, because the oikos-* prefix belongs to the DSL — see DISAMBIGUATION.adoc." }, + { name = "eclexia", repo = "hyperpolymath/eclexia", relation = "policy-language + future-host", note = "Turing-complete general-purpose language implementing the Economics-as-Code paradigm; far broader in scope than this bot. Today: the .ecl policy surface (currently evaluated by a filename-matching FAKE backend — see DEBT.adoc). Intended trajectory: OikosBot's dominance/frontier maths moves into the Eclexia stdlib so its currently-inert @optimize becomes semantically real for every Eclexia program; OikosBot's DEA duals become the real solver behind shadow_price(), replacing hand-set constants; and OikosBot is eventually IMPLEMENTED IN Eclexia. OikosBot is its first serious application, not its owner." }, + { name = "standards", repo = "hyperpolymath/standards", relation = "reusable-workflows", note = "Supplies the reusable workflows this repo calls (mirror, secret-scanner, scorecard, governance). Pin bumps here are estate-coordinated." } ] diff --git a/.machine_readable/6a2/STATE.a2ml b/.machine_readable/6a2/STATE.a2ml index ffe26e9..c4705e5 100644 --- a/.machine_readable/6a2/STATE.a2ml +++ b/.machine_readable/6a2/STATE.a2ml @@ -5,14 +5,14 @@ [metadata] project = "oikosbot" version = "0.1.0-dev" -last-updated = "2026-07-28" +last-updated = "2026-08-07" status = "active" -session = "2026-07-28 generation-1 go-live: Pareto engine made executable (#42 — crates/oikosbot-pareto: ε-tolerant dominance, normalized weighted frontier, base-vs-head verdicts with confidence gating, oikosbot compare, SARIF pareto_* properties, EconScore composition per ARCHITECTURE); .oikos.yml --config + auto-discovery (estate configs + governance flag now real); push-email-notify removed (dual-use ruling); publish-image root-caused to GHCR package access (permission_denied: write_package — owner grant, Containerfile verified sound via podman); composite action.yml + docs/COMPARISON-climate-warrior.adoc. Rulings: Action-mode first then App; NO interim listener (upstream AffineScript Http::Server instead); advisor + machine-checked trade-offs; Scallop replaces DeepProbLog. Prior session: 2026-06-21 close-out of the post-extraction work: fleet bridge → BotId::Oikosbot + ReScript-era containers removed (#5); finding taxonomy in NEUROSYM.a2ml [finding-taxonomy] + policies/finding_taxonomy.ecl (#9); robot-repo-automaton build fix + Rust build/test/clippy CI gate (gitbot-fleet); stale-identity sweep across SECURITY/CLAUDE/META (#11); standards reusable-workflow pin refresh (#13); LICENSE dual-SPDX MPL-2.0 + CC-BY-SA-4.0, SECURITY.md finalized (reporting → j.d.a.jewell@open.ac.uk), redundant trufflehog job dropped (#14); added docs/README.adoc documentation map. Open follow-ups: #12 (taxonomy vocab reconciliation), #16 (developer+maintainer docs + README split), #17 (end-user docs), #18 (taxonomy tags through Finding types)." +session = "2026-08-07 documentation + debt audit: DEBT.adoc written (licence/docs/code/proof/CI-CD, every item evidenced); removed an UNEARNED OpenSSF Best Practices badge (API returns empty — never registered); deleted ARCHITECTURE.md and GOVERNANCE.md (generic boilerplate describing a src/tests/ layout this repo does not have, shadowing the real .adoc versions); deleted orphaned LICENSES/AGPL-3.0-or-later.txt (no file declares it); fixed docs/README.adoc's DUPLICATED SPDX header (MPL-2.0 on line 1 shadowing CC-BY-SA-4.0 on line 2 — a doc licensed as code, and a class of defect that passes the presence check while asserting the wrong licence); ARCHITECTURE.adoc banner-flagged as TARGET design with each unbuilt component named; tech-debt-2026-05-26.adoc marked superseded; wiki built out from a one-line stub; repo description and topics set. Prior session 2026-08-03/04 estate economics round one: #60 merged (oikosbot-telemetry/-capability/-dea + estate CLI), oikosbot-estate snapshot repo created, #65 in review (path-keyed gate detection). Prior: 2026-07-28 generation-1 go-live: Pareto engine made executable (#42 — crates/oikosbot-pareto: ε-tolerant dominance, normalized weighted frontier, base-vs-head verdicts with confidence gating, oikosbot compare, SARIF pareto_* properties, EconScore composition per ARCHITECTURE); .oikos.yml --config + auto-discovery (estate configs + governance flag now real); push-email-notify removed (dual-use ruling); publish-image root-caused to GHCR package access (permission_denied: write_package — owner grant, Containerfile verified sound via podman); composite action.yml + docs/COMPARISON-climate-warrior.adoc. Rulings: Action-mode first then App; NO interim listener (upstream AffineScript Http::Server instead); advisor + machine-checked trade-offs; Scallop replaces DeepProbLog. Prior session: 2026-06-21 close-out of the post-extraction work: fleet bridge → BotId::Oikosbot + ReScript-era containers removed (#5); finding taxonomy in NEUROSYM.a2ml [finding-taxonomy] + policies/finding_taxonomy.ecl (#9); robot-repo-automaton build fix + Rust build/test/clippy CI gate (gitbot-fleet); stale-identity sweep across SECURITY/CLAUDE/META (#11); standards reusable-workflow pin refresh (#13); LICENSE dual-SPDX MPL-2.0 + CC-BY-SA-4.0, SECURITY.md finalized (reporting → j.d.a.jewell@open.ac.uk), redundant trufflehog job dropped (#14); added docs/README.adoc documentation map. Open follow-ups: #12 (taxonomy vocab reconciliation), #16 (developer+maintainer docs + README split), #17 (end-user docs), #18 (taxonomy tags through Finding types)." [project-context] name = "OikosBot" purpose = "OikosBot — an ecological & economic code-analysis GitHub/GitLab App. NB: the similarly-named 'oikos' DSL (separate repo hyperpolymath/oikos-economics-accounting-dsl) and the 'sustainabot' gitbot-fleet slot are SEPARATE projects — see DISAMBIGUATION.adoc." -completion-percentage = 50 +completion-percentage = 60 [position] phase = "implementation" # design | implementation | testing | maintenance | archived @@ -26,13 +26,20 @@ milestones = [ { id = "stdlib-json-v03", status = "landed-upstream", repo = "affinescript", pr = 421, summary = "stdlib/json.affine RSR rewire to hpm-json-rsr Zig FFI — unblocks OikosBot webhook payload extraction" }, { id = "stdlib-http-server", status = "landed-upstream", repo = "affinescript", pr = 425, summary = "stdlib/Http.affine RSR rewire — surfaces hpm-http-rsr Zig FFI server externs — unblocks OikosBot accept loop" }, { id = "bot-affine-implementation", status = "in-progress", summary = "Orchestration handler wired: Payload.affine extracts PR fields (stdlib json lazy descent) and handle_github_webhook calls Oikos.handle_pr_event (HMAC already done). REMAINING: bind the HTTP listener (Sub.http_server), gated on the stdlib Http::Server host type. NOTE: AffineScript unverified — no AS toolchain in env." }, - { id = "db-single-verisimdb", status = "in-progress", summary = "Retarget data layer to a single VeriSimDB store; octad witnesses subsume ArangoDB (graph/document) + Virtuoso (semantic). Design + config done this session; runtime client deferred/gated (VeriSimDB v0.1.0 + AffineScript transport)." } + { id = "db-single-verisimdb", status = "in-progress", summary = "Retarget data layer to a single VeriSimDB store; octad witnesses subsume ArangoDB (graph/document) + Virtuoso (semantic). Design + config done this session; runtime client deferred/gated (VeriSimDB v0.1.0 + AffineScript transport)." }, + { id = "estate-economics-round-one", status = "landed", pr = 60, summary = "Estate as the unit of analysis. New crates oikosbot-telemetry (gh-API collector, Parquet snapshots, derived energy/carbon/cost), oikosbot-capability (verified-capability output metrics incl. fake-gate detection from run history), oikosbot-dea (Data Envelopment Analysis: input-oriented CCR + BCC solved as paired envelopment/multiplier LPs on good_lp+HiGHS, yielding theta, peer reference sets and dual weights). New `oikosbot estate collect|analyse|report` CLI. Read-only by design: reports, does not gate. Rationale: allocative efficiency is undefined for a single diff — it needs competing claims on a shared budget." }, + { id = "estate-snapshot-repo", status = "landed", summary = "hyperpolymath/oikosbot-estate created — versioned Parquet snapshots + analysis.json + rendered report, one directory per collection run. Data lives outside oikosbot so the tool never silently measures a corpus containing itself, and so snapshot history is git history." }, + { id = "path-keyed-gate-detection", status = "in-review", pr = 65, summary = "Final-review fix: capability assess() grouped by workflow_name (free text, non-unique) which merged distinct same-named workflows and could hide a fake-gate candidate behind a same-named failing one. Now keyed on workflow_path. Re-run found 1482 candidates across 313 repos vs 1270 by the earlier by-name method — the concealment was real. Also: local staging write failures now log-and-continue rather than aborting a multi-owner sweep." } ] [blockers-and-issues] issues = [ { id = "github-actions-budget", severity = "operational", summary = "Actions spending limit exhausted intermittently across the estate. Signature: job conclusion 'failure' with ZERO steps and the annotation 'job was not started because recent account payments have failed'. Hit 2 of 15 swept consumer repos (chronicles-of-slavia, canonical-ums — the latter private). NOT a workflow defect; do not debug the workflow when steps==0." }, - { id = "enforcement-inert", severity = "design", summary = "`--check` cannot block a merge: only Measured/Calibrated inputs may fail a run and the analyzer emits only Estimated (calibration.rs exists but estimate_resources() is still naive complexity*0.1 J). Refusal is LOUD (::warning::) as of #47, never silent. Real fix tracked in issue #48." }, + { id = "actions-lockfile-enforcement", severity = "resolved", summary = "RESOLVED for this repo. GitHub's Actions workflow-lockfile enforcement killed every workflow estate-wide at startup (0s startup_failure, error visible only on the run's HTML page). Cured by shipping .github/workflows/actions.lock in #61; reusable-caller permissions fixed in #63. CI now runs green (Hypatia, Secret Scanner, Governance, Language Policy, CodeQL). Consumers still need their own lockfiles — see consumer-fleet-dark." }, + { id = "enforcement-inert", severity = "design", summary = "PER-FILE path only: `--check` cannot block a merge, since only Measured/Calibrated inputs may fail a run and the analyzer emits only Estimated (calibration.rs exists but has ZERO callers; estimate_resources() is still naive complexity*0.1 J). Refusal is LOUD (::warning::) as of #47, never silent. Real fix tracked in issue #48. NOTE the ESTATE path is now the exception: oikosbot-telemetry derive.rs assigns Confidence::Measured to wall_minutes from the GitHub API — the first genuinely Measured quantity in the system." }, + { id = "per-file-collinearity", severity = "design", summary = "estimate_resources() derives energy, duration, carbon and memory from ONE integer (complexity = raw AST node count), so four of five Pareto objectives are scalar multiples of each other and the frontier collapses to a 1-D sort. The dominance maths in oikosbot-pareto is correct; the inputs make it near-vacuous. SOLVED at estate level (telemetry axes measured independent: wall_minutes~size_kb = -0.049 across 381 repos). UNSOLVED at file level. See DEBT.adoc." }, + { id = "policy-engines-never-execute", severity = "design", summary = "TWO fake gates. (1) policy-engine/datalog/eco_rules.dl has never executed — Souffle is DECLARED in guix/manifest.scm and guix/oikos.scm but invoked nowhere (no match in Justfile, *.just or any workflow); its allocation-waste and debt rules have no Rust counterpart. (2) oikosbot-eclexia's default backend dispatches on the .ecl FILE STEM and never reads file contents; its hardcoded thresholds contradict the files (energy_threshold.ecl says >50 J per function, builtin fires >1000 J total). Mitigated by a loud ::warning:: in #59; still fake." }, + { id = "consumer-fleet-dark", severity = "operational", summary = "15 estate repos carry .github/workflows/oikosbot.yml pinned to oikosbot@bb95ab50 (v0.1.0), all merged — but each needs its OWN Actions lockfile before its workflows can start. OikosBot is installed everywhere and running nowhere. Highest-value follow-up." }, { id = "idaptik-ums-repo-wide-startup-failure", severity = "external", summary = "metadatastician/idaptik-ums fails ALL workflows at startup on main (OikosBot, Licence hygiene, CodeQL), with two workflows displayed as PATHS not names — the estate tell for never-parsed. Repo-level, pre-existing, not caused by the OikosBot sweep (the same file succeeded on a branch there)." } ] @@ -43,7 +50,10 @@ actions = [ { id = "bot-affine-webhook-handler", priority = "P2", summary = "Wire the AS-side webhook receiver in bot-integration-affine/ using Http server + Json stdlib externs (ruled: do the upstream AffineScript work, no interim listener)" }, { id = "hpm-json-object-keys", priority = "P3", summary = "Add hpm_json_object_keys export to hpm-json-rsr Zig FFI to close the JObject materialisation gap in stdlib/json.affine to_json" }, { id = "scallop-policy-engine", priority = "P3", summary = "Port policy-engine/datalog/eco_rules.dl to Scallop (Rust neurosymbolic Datalog) and retire the Python DeepProbLog assets. Ruled 2026-07-28; no Python exemption." }, - { id = "verisimdb-client", priority = "P4", summary = "Build the deferred VeriSimDB client (Zig-FFI connector mirroring the hpm-* pattern, or a REST client from the AS transport); gated on VeriSimDB maturity + affinescript #421/#425 integration" } + { id = "verisimdb-client", priority = "P4", summary = "Build the deferred VeriSimDB client (Zig-FFI connector mirroring the hpm-* pattern, or a REST client from the AS transport); gated on VeriSimDB maturity + affinescript #421/#425 integration" }, + { id = "consumer-lockfile-sweep", priority = "P1", summary = "Ship an Actions lockfile into each of the 15 consumer repos carrying oikosbot.yml so the installed workflows can actually start. Until then OikosBot is installed everywhere and running nowhere — the single highest-value follow-up now that this repo's own CI is green." }, + { id = "estate-round-two-decision", priority = "P2", summary = "Round two is decided by evidence, not pre-committed. Candidates: (A) export DEA duals as shadow prices and wire Eclexia's inert @optimize via a shared dominance crate; (B) enforcement + calibration (#48); (C) deepen the substrate (stock-flow-consistency identity checks, static capability signals, longer backfill). Decision criterion: the independence matrix, dual stability across >=2 snapshots, and telemetry coverage — all reported by the pipeline itself. Requires snapshot #2." }, + { id = "pr-decoration", priority = "P2", summary = "The one table stake every comparable product has and OikosBot lacks: a single updated-in-place PR comment with a one-line verdict header and an honest estimated/measured count. SARIF-to-code-scanning is not a substitute — it does not gate merges and reviewers do not open the Security tab during review. Blocked on nothing." } ] [verified-facts] @@ -54,7 +64,12 @@ facts = [ { id = "json-valid-is-not-sarif-valid", statement = "serde_json parsing success proves parseable JSON only, NOT SARIF schema validity. That weaker check is what let the fixes[] defect ship." }, { id = "pages-first-ever-deploy", statement = "https://hyperpolymath.github.io/oikosbot/ returns 200. It had NEVER deployed: 30/30 casket-pages runs showed 'cancelled', which were timeout expiries (cold GHC build > timeout-minutes 15) — GitHub reports timeout as 'cancelled', not 'failed'." }, { id = "linter-was-vacuous", statement = "workflow-linter.yml 'Check pinned actions' could not fail on any input (never incremented, no exit) and globbed only .github/workflows. Fixed #46: increments+exits, scans examples/, and probes SHA EXISTENCE via the API. Falsifier-verified: exit 2 on a tag ref plus a real phantom SHA." }, - { id = "phantom-sha-scale", statement = "Local grep suggested 149 files / 120 repos; measured against ORIGIN it is 31 files, of which only 7 are root-level (executable). 24 are nested inside monorepos where GitHub never executes them." } + { id = "phantom-sha-scale", statement = "Local grep suggested 149 files / 120 repos; measured against ORIGIN it is 31 files, of which only 7 are root-level (executable). 24 are nested inside monorepos where GitHub never executes them." }, + { id = "estate-axes-independent", statement = "MEASURED 2026-08-03 over 381 repos / 69,445 runs: pearson(wall_minutes, size_kb) = -0.049. This is the falsifier for the whole estate design — had compute time proved to be a proxy for code volume, the DEA inputs would have been one variable in disguise and the premise would have failed. It did not." }, + { id = "analyse-deterministic", statement = "Two independent `estate analyse` runs over frozen staging produce BYTE-IDENTICAL analysis.json (verified by diff of jq -S output). No HashMap, no timestamps, no filesystem-order leakage in the analyse path." }, + { id = "grouping-key-concealed-candidates", statement = "MEASURED 2026-08-07: grouping runs by workflow_name rather than workflow_path merged distinct same-named workflows and concealed fake-gate candidates. By path: 1482 candidates across 313 repos; by name: 1270. The 212-candidate gap is the concealment, and it is why the shipped key is workflow_path." }, + { id = "openssf-badge-was-unearned", statement = "MEASURED 2026-08-07: the README carried a hardcoded green 'OpenSSF Best Practices' badge linking to bestpractices.dev/en/projects/NEW (the registration form). The OpenSSF API (projects.json?url=.../oikosbot) returns EMPTY — the project is not registered and holds no badge. Removed. Template-drift pattern; grep the estate for the same block." }, + { id = "souffle-packaged-never-invoked", statement = "MEASURED 2026-08-07: souffle IS declared in guix/manifest.scm and guix/oikos.scm, but `grep -rn souffle Justfile *.just .github/workflows/*.yml` returns NOTHING. The toolchain is packaged, the Datalog rules are written, and the two are never connected." } ] [maintenance-status] diff --git a/ARCHITECTURE.adoc b/ARCHITECTURE.adoc index f3428b2..4301243 100644 --- a/ARCHITECTURE.adoc +++ b/ARCHITECTURE.adoc @@ -4,6 +4,29 @@ = Oikos Bot: Ecological & Economic Code Analysis Platform +[WARNING] +==== +*This is the TARGET design, not the current state.* Read it as intent. Several +components specified below were never built, and one contradicts a later +ruling: + +* *§"OCaml Documentation Analyzer" (`/analyzers/docs-ocaml/`)* — does not + exist. `analyzers/` contains only `code-haskell`. +* *§"Policy Engine (Datalog + DeepProbLog)" and the tech-stack table's "Python + + Datalog"* — superseded. Python is banned by the language policy, and the + 2026-07-28 ruling retargets the engine to *Scallop* (Rust). The Datalog rules + in `policy-engine/datalog/eco_rules.dl` have never executed. +* *Four bot roles ("consultant, advisor, regulator, and policy developer")* — + `crates/oikosbot-cli/src/config.rs` implements three. There is no `policy + developer` mode. +* *The Praxis Loop and DeepProbLog inference* — not implemented. + +It also predates the *estate* pipeline (`oikosbot-telemetry` / `-capability` / +`-dea`), which is the newest and most evidentially solid surface. For what is +actually built, see link:docs/STATUS.adoc[`docs/STATUS.adoc`], +link:EXPLAINME.adoc[`EXPLAINME.adoc`] and link:DEBT.adoc[`DEBT.adoc`]. +==== + [NOTE] ==== *Note — which product is this?* diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md deleted file mode 100644 index 607e3d8..0000000 --- a/ARCHITECTURE.md +++ /dev/null @@ -1,47 +0,0 @@ -# Architecture - -## Overview - -This repository follows a modular, maintainable architecture designed for clarity, scalability, and long-term sustainability. - -## Directory Structure - -``` -. -├── src/ # Source code -├── tests/ # Test suites -├── docs/ # Documentation -├── scripts/ # Utility scripts -├── config/ # Configuration files -├── LICENSE # License file -├── LICENSES/ # Full license texts -└── README.adoc # Project documentation -``` - -## Design Principles - -- **Separation of Concerns**: Each module has a single responsibility -- **Testability**: Code is written to be easily testable -- **Documentation**: All public APIs are documented -- **Configuration**: Environment-specific settings are externalized - -## Dependencies - -- External dependencies are minimized and clearly declared -- Version pinning is used for reproducibility - -## Security Considerations - -- Sensitive data is never committed to the repository -- Secrets are managed through environment variables or secure vaults -- Regular dependency audits are performed - -## Maintainability - -- Code follows consistent style guidelines -- Pull requests require review and CI checks -- Issues and discussions are tracked transparently - ---- - -*Last updated: 2026-07-18* diff --git a/DEBT.adoc b/DEBT.adoc new file mode 100644 index 0000000..d7db76a --- /dev/null +++ b/DEBT.adoc @@ -0,0 +1,417 @@ +// SPDX-License-Identifier: CC-BY-SA-4.0 +// SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell += OikosBot — Debt Register +Jonathan D.A. Jewell +:toc: preamble +:toclevels: 2 + +Audited 2026-08-07. Supersedes link:docs/tech-debt-2026-05-26.adoc[`docs/tech-debt-2026-05-26.adoc`]. + +A tool that prices other repositories' waste has no business hiding its own. +Every entry below is evidenced with a file reference or a command whose output +can be reproduced; nothing is asserted from memory. Where a claim could not be +verified, it says so. + +Severity is about *consequence*, not effort: + +[cols="1,4"] +|=== +| `BLOCKING` | Something advertised does not work. A user relying on it is misled. +| `STRUCTURAL` | Sound today, but the design will not carry the next increment. +| `HYGIENE` | Real, bounded, no blast radius. +|=== + +== Summary + +[cols="1,1,4"] +|=== +| Area | Worst | One-line + +| <> | HYGIENE | One orphaned licence text; one doc missing its SPDX header. +| <> | STRUCTURAL | Two boilerplate files describe a directory layout this repo does not have; `ARCHITECTURE.adoc` specifies components that were never built. +| <> | BLOCKING | The per-file analyser derives every resource axis from one integer, so its Pareto frontier is a one-dimensional sort. +| <> | BLOCKING | The Datalog policy engine has never executed; the Eclexia policy backend matches on filenames and never reads the files. +| <> | HYGIENE | Repo CI is green; the consumer fleet cannot run until each repo ships a lockfile. +|=== + +[#licence] +== Licence debt + +The scheme itself is sound and consistently applied: **MPL-2.0 for code, +CC-BY-SA-4.0 for documentation**, 78 and 29 declarations respectively +(`grep -rhoP "SPDX-License-Identifier: \K[A-Za-z0-9.+-]+"`). + +[cols="1,4"] +|=== +| `HYGIENE` | *`LICENSES/AGPL-3.0-or-later.txt` is orphaned.* No file in the +repository declares `SPDX-License-Identifier: AGPL-3.0-or-later`; the only +textual occurrence of "AGPL" outside `LICENSES/` is a *quotation of another +repo's* header inside `docs/superpowers/specs/`. A REUSE-conformant tree +carries licence texts only for licences actually in use, so this reads as an +unused licence. *Fix:* delete the file. *Risk if wrong:* if a future file +genuinely needs AGPL, re-add it then. + +| `HYGIENE` | *`GOVERNANCE.md` carries no SPDX header at all* — see +<>, where it is slated for deletion as boilerplate. Every other document +in the tree has one. + +| `HYGIENE` | *`docs/README.adoc` was mis-licensed by a duplicated header.* It +carried **two** conflicting identifiers — `MPL-2.0` on line 1 and +`CC-BY-SA-4.0` on line 2. Because the linter reads `head -1`, the documentation +map was being licensed as code. *Fixed in this audit* by removing the stray +MPL-2.0 line; the CC-BY-SA-4.0 identifier is now line 1. Worth noting as a +class: a *duplicated* header is more dangerous than a missing one, because it +passes the presence check while asserting the wrong licence. + +| `HYGIENE` | *SPDX headers must be on line 1.* The estate's linter greps +`head -1` only, so a header on line 3 reads as *missing*. Verified compliant +across the round-one crates (`oikosbot-telemetry`, `-capability`, `-dea`, +`oikosbot-cli/src/estate.rs`). Recorded here because the failure mode is +invisible: a correct header in the wrong position silently fails the gate. +|=== + +[#docs] +== Documentation debt + +[cols="1,4"] +|=== +| `STRUCTURAL` | *`ARCHITECTURE.md` is generic boilerplate that contradicts the +repository.* It documents a `src/ tests/ scripts/ config/` layout; this repo is +a Cargo workspace whose code lives in `crates/`. It has no SPDX header, and it +shadows the real 33 KB `ARCHITECTURE.adoc` — a reader who opens the `.md` +learns nothing true. *Fix:* delete. Template rot, not authored content. + +| `STRUCTURAL` | *`GOVERNANCE.md` is the same defect* — generic prose +("governed by the following principles and structures") duplicating the real, +SPDX-headed `GOVERNANCE.adoc`. *Fix:* delete. + +| `STRUCTURAL` | *`ARCHITECTURE.adoc` specifies components that do not exist.* +Measured against the tree: ++ +* §196 specifies an *OCaml documentation analyzer* at `/analyzers/docs-ocaml/`. + `analyzers/` contains only `code-haskell`. +* §424 lists the policy engine as *"Python + Datalog"*. Python is banned by the + language policy, and the 2026-07-28 ruling retargeted the engine to Scallop + (Rust). The document was never updated. +* §29 describes four bot roles — *consultant, advisor, regulator, and policy + developer*. `crates/oikosbot-cli/src/config.rs` implements three; there is no + `policy developer` mode. +* §121–§358 describe a *Praxis Loop* and DeepProbLog inference that are not + implemented. ++ +*Fix:* mark it explicitly as *target design, not current state*, and annotate +each unbuilt component inline — the cheapest honest option, given it is a real +design document rather than rot. + +| `BLOCKING` | *The README carried an unearned OpenSSF Best Practices badge.* +A hardcoded green `shields.io` image asserting "OpenSSF Best Practices", linked +to `bestpractices.dev/en/projects/**new**?repo_url=…` — the *registration* +form, not an earned listing. Querying the OpenSSF API +(`bestpractices.dev/projects.json?url=…/oikosbot`) returns an **empty result**: +the project is not registered, holds no badge, and has passed no criteria. +A green compliance badge nobody awarded is a claim about security posture that +the project cannot support. *Removed in this audit.* This matches a documented +estate-wide template-drift pattern; other repos should be grepped for the same +badge block. + +| `STRUCTURAL` | *The wiki is a one-line stub* ("Welcome to the oikosbot +wiki!"). It is enabled and indexed, so it is a discoverable dead end. + +| `HYGIENE` | *Taxonomy vocabulary collision* (issue +https://github.com/hyperpolymath/oikosbot/issues/12[#12]): +`META.a2ml [maintenance-axes]` and `NEUROSYM.a2ml [finding-taxonomy]` define +overlapping-but-different vocabularies for the same concept. Unreconciled. + +| `HYGIENE` | *`config/oikos.yaml` advertises capabilities that do not exist* — +PR comments, a dashboard on `:8080`, OTel export, Slack/email notification, a +praxis loop. The loader parses and silently discards them. Mitigated in +https://github.com/hyperpolymath/oikosbot/pull/59[#59] by marking each block +`ASPIRATIONAL`; the blocks themselves remain. + +| `HYGIENE` | *Open docs issues* +https://github.com/hyperpolymath/oikosbot/issues/16[#16] (split README into a +docs tree) and https://github.com/hyperpolymath/oikosbot/issues/17[#17] +(end-user guide: interpreting findings, SARIF, policy customisation) remain +open and are only partly addressed by `docs/README.adoc`. +|=== + +[#code] +== Code debt + +=== The collinearity problem (the important one) + +[cols="1,4"] +|=== +| `BLOCKING` | *Every resource axis in the per-file analyser is a scalar +multiple of one integer.* `Analyzer::estimate_resources()` +(`crates/oikosbot-analysis/src/analyzer.rs:199`) derives all four axes from +`complexity`, a raw AST **node count**: ++ +[source,rust] +---- +let energy = Energy::joules(complexity as f64 * 0.1); +let duration = Duration::milliseconds(complexity as f64 * 0.5); +let carbon = estimate_carbon(energy); // energy × 1.319e-4 +let memory = Memory::kilobytes(complexity * 2); +---- ++ +A Pareto frontier over collinear axes collapses to a one-dimensional sort. The +dominance mathematics in `crates/oikosbot-pareto` is correct — ε-tolerant, +min-max normalised before any distance is taken, weights inside the metric — +but the inputs make it nearly vacuous. The same root cause makes the EconScore +terms non-independent: `Alloc` reduces to roughly `0.35 × complexity` +rank-inverted, and `Debt` is `100 − 0.5 × complexity`. ++ +*Status:* solved at **estate** level by round one (telemetry gives money, time, +energy and carbon as mutually independent axes — measured +`wall_minutes ~ size_kb` correlation is −0.049). *Unsolved at file level.* + +| `BLOCKING` | *`calibration.rs` has zero callers* (issue +https://github.com/hyperpolymath/oikosbot/issues/48[#48]). The module is +written in full — `OperationKind`, `ResourceRange`, pattern multipliers — and +nothing calls `calibrated_estimate()` or `estimate_operation()`. Verified: +`grep -rn "calibrated_estimate\|estimate_operation" crates/` matches only the +defining file. + +| `BLOCKING` | *Consequence: `compare --check` cannot block.* Only +`Measured`/`Calibrated` inputs may fail a run; the analyser emits only +`Estimated`, so `assess().actionable` is always false. Since +https://github.com/hyperpolymath/oikosbot/pull/47[#47] it refuses *loudly* +rather than passing silently — the honest handling of a gate that cannot yet +gate, but the gate still cannot gate. ++ +*Round one changed this partially:* `Confidence::Measured` is now produced for +the first time, at `crates/oikosbot-telemetry/src/derive.rs:99`, for +`wall_minutes`. The estate path has Measured data; the per-file path does not. + +| `STRUCTURAL` | *`aggregate_point` sums resources but averages quality* +(`crates/oikosbot-pareto`), so a `compare` verdict is sensitive to file +*count*: adding files raises summed carbon even when per-unit efficiency +improved. + +| `STRUCTURAL` | *Epsilon and objective weights are compile-time constants.* +`DEFAULT_EPSILON` is not configurable, and `result_objectives()` hardcodes the +weights, while `config/oikos.yaml` advertises a `weights:` block that the +loader discards. + +| `STRUCTURAL` | *`standard_objectives()` is dead code* — seven axes declared +per `ARCHITECTURE.adoc`, never called. The live set is `result_objectives()` +(five axes, no coverage or debt axis). +|=== + +=== Language and detection coverage + +[cols="1,4"] +|=== +| `STRUCTURAL` | *TypeScript is parsed with the JavaScript grammar* +(`crates/oikosbot-analysis/src/language.rs`), so TS-specific syntax +mis-parses. Worse, `config.rs::language_extension` maps only `rs`/`js`/`py`, so +`.ts` files are reachable via `analyze ` but **never** via `check`/`report` +directory scans. + +| `STRUCTURAL` | *The estate this tool serves is Zig- and Idris-heavy*, and the +analyser supports Rust, JavaScript and Python only. Round one sidesteps this +(CI telemetry is language-agnostic — which is why the Zig/Idris repos are +measurable at all), but per-file analysis cannot see most of the estate. + +| `HYGIENE` | *Pattern detection is Rust-idiom-biased.* `detect_patterns` +combines AST-kind matching with **substring search on node source text**, +producing false negatives on JS and Python. + +| `HYGIENE` | *Detected patterns never affect the estimate.* `impact_multiplier` +is computed and attached to findings but is never applied in `analyzer.rs`; the +multiplier logic lives only in the unwired calibration path — and the two +multiplier tables (`patterns.rs` and `calibration.rs`) are duplicated with no +shared source of truth. +|=== + +=== Round-one pipeline (`oikosbot-telemetry` / `-capability` / `-dea`) + +[cols="1,4"] +|=== +| `STRUCTURAL` | *Zero-run repos silently vanish from the analysis.* +`derive_per_repo` only emits repos with ≥1 run, so a repo present in the +snapshot with no CI history appears in no `derived`, `capability`, or `dea` +array. Documented in the `run_analysis` doc comment; not surfaced in the report. + +| `STRUCTURAL` | *DEA scores zero-output units at θ = 0.0 with empty peer +sets.* Mathematically consistent with the `1e-6` output flooring, but it reads +oddly and gives no actionable peer. The X-inefficiency class (real input, zero +verified output) should be reported separately from the efficiency frontier +rather than scored on it. + +| `HYGIENE` | *`dea()` aborts the whole batch if one LP fails*, rather than +returning partial results. Deliberate for round one — loud failure beats silent +partial data — but at ~400 DMUs one degenerate unit takes down every score in +the call. + +| `HYGIENE` | *`floored()` is computed twice per DMU* (once for inputs, once for +outputs), discarding half the work each time. + +| `HYGIENE` | *Snapshot schema drift is silent.* `ParquetRecordReader` requires +`Default` and backfills missing columns rather than erroring, so reading an old +snapshot against a newer struct yields zeros instead of a diagnostic. Harmless +at one schema version; a trap at two. Needs a schema version field before +snapshot #2 introduces a second shape. + +| `HYGIENE` | *`collect_runs` fetches one avoidable empty page per repo* — the +loop breaks on an empty page rather than a short one. + +| `HYGIENE` | *No CI coverage for the estate pipeline.* `collect` needs network +and `gh` auth, so it is exercised only locally. `analyse`/`report` are +deterministic and could be tested against a committed fixture snapshot; they +are not. +|=== + +[#proof] +== Proof and policy debt + +This is the area where the gap between what the repository *claims* and what it +*executes* is widest. + +[cols="1,4"] +|=== +| `BLOCKING` | *`policy-engine/datalog/eco_rules.dl` has never executed.* It is +Souffle-dialect Datalog defining the eco/econ/Pareto/allocation/debt rule set. +Nothing in the repository invokes it: no Souffle call in `Justfile`, any +`.just` file, or any workflow (`grep -rn souffle Justfile *.just +.github/workflows/*.yml` → no matches). ++ +Sharpening the point: **Souffle *is* declared as a dependency** in +`guix/manifest.scm` and `guix/oikos.scm`. The toolchain is packaged, the rules +are written, and the two are never connected. `docs/STATUS.adoc` states this +honestly — the file is "a specification, kept as the reference the Rust +dominance code conforms to" — and the Rust conformance is a hand-written test, +not an execution. ++ +*Consequence:* the allocation-waste and technical-debt rules declared in the +Datalog have **no Rust counterpart at all**. The `Alloc` and `Debt` terms in +EconScore are unrelated stand-ins, not implementations of those rules. + +| `BLOCKING` | *The Eclexia policy backend is a fake gate.* `oikosbot-eclexia` +has three backends; the one that runs by default, `evaluate_builtin`, +dispatches on the `.ecl` **file stem** and applies hardcoded Rust thresholds. +*The file's contents are never read.* The thresholds contradict the files they +claim to implement: `policies/energy_threshold.ecl` declares `> 50.0 J` **per +function**; the builtin fires at `> 1000 J` **total**. ++ +*Mitigated, not fixed*, in https://github.com/hyperpolymath/oikosbot/pull/59[#59]: +every builtin evaluation now emits `::warning::… file contents NOT parsed`. It +is loud, and still fake. + +| `STRUCTURAL` | *The `eclexia-native` backend cannot compile.* It is gated +behind a feature whose crates (`eclexia_parser`, `eclexia_interp`) are not +declared dependencies, so the cfg branch is unbuildable — a seam, not an +implementation. + +| `HYGIENE` | *`policy-engine/deepproblog/eco_problog.pl` is dead by ruling* +(2026-07-28: policy engine → Scallop, Python DeepProbLog retired with no +exemption) but the asset is still in the tree. + +| `HYGIENE` | *DEA correctness is verified against self-authored analytic cases* +— closed-form single-input/output, a strictly-dominated unit, and a strong-duality +assertion (`|θ_env − θ_mult| < 1e-5`, genuinely strong evidence). It has *not* +been validated against a published worked example with a citation, which is the +standard that would make the implementation externally defensible. +|=== + +[#cicd] +== CI/CD debt + +The picture improved sharply in the last few days; what remains is mostly +downstream. + +[cols="1,4"] +|=== +| — | *Resolved:* the estate-wide `startup_failure` epidemic (GitHub's Actions +workflow-lockfile enforcement) is cured for this repo — +`.github/workflows/actions.lock` shipped in +https://github.com/hyperpolymath/oikosbot/pull/61[#61] and CI now runs green +(Hypatia, Secret Scanner, Governance, Language Policy, CodeQL all `success`). +Reusable-caller permissions fixed in +https://github.com/hyperpolymath/oikosbot/pull/63[#63]. + +| `BLOCKING` | *Four phantom required contexts block every pull request, so +every merge needs `--admin`.* The `main` ruleset requires 27 status checks. All +27 checks that *can* report do report and pass — but four of the required +contexts never appear, so `mergeStateStatus` is permanently `BLOCKED`: ++ +[cols="2,3"] +!=== +! Required context ! Why it never reports + +! `Build and push oikos image` +! `publish-image.yml` triggers only on `push: branches: [main]`. It cannot run + on a pull request, so **no PR can ever satisfy it**. Structurally + unsatisfiable, not merely absent. + +! `Dependabot` +! Reports only on Dependabot's own PRs. Unsatisfiable on any human PR. + +! `governance / Guix primary / Nix fallback policy` +! The job was **renamed** to `governance / Guix packaging policy (Nix + retired)`. Renaming a job silently orphans the required context that names + it — the ruleset still waits for a name nothing emits. + +! `lint-workflows` +! Declared as a job in `workflow-linter.yml` but did not report on the PR + measured; the governance-scoped `governance / Workflow security linter` + did. Looks like a duplicate/stale entry; needs confirmation. +!=== ++ +*Consequence, and it is worse than the inconvenience:* branch protection that +can never be satisfied is not protection. It trains everyone to merge with +`--admin`, which bypasses **all** the checks — including the 23 real ones — so +the net effect of over-specifying the ruleset is *less* enforcement than +specifying it correctly. *Fix:* drop the two structurally unsatisfiable +contexts, rename the Guix one to match the job, and confirm the fourth. ++ +*Reproduce:* +`comm -23 <(gh api repos/hyperpolymath/oikosbot/rules/branches/main -q '.[]|select(.type=="required_status_checks")|.parameters.required_status_checks[].context'|sort -u) <(gh pr checks | cut -f1 | sort -u)` + +| `STRUCTURAL` | *The consumer fleet is still dark.* Fifteen estate repos carry +`.github/workflows/oikosbot.yml` pinned to `oikosbot@bb95ab50` (v0.1.0), all +merged — but each needs its **own** Actions lockfile before its workflows can +start. Until then OikosBot is installed everywhere and running nowhere. This is +the single highest-value follow-up. + +| `HYGIENE` | *`scorecard.yml` runs per-push*; making it periodic is open as +https://github.com/hyperpolymath/oikosbot/pull/64[#64]. + +| `HYGIENE` | *`instant-sync.yml` is disabled* (`disabled_manually`) and +undocumented — neither retired nor explained. + +| `HYGIENE` | *`push-email-notify.yml` is dormant by design* but remains in the +tree; the estate's dual-use ruling calls for removing push-email workflows +except where explicitly exempted. +|=== + +== What is *not* debt + +Recorded so it is not re-litigated: + +* *The dominance engine* (`crates/oikosbot-pareto`) is correct work: ε-tolerant + comparison, min-max normalisation before distance, weights participating in + the metric, total functions, and property-flavoured tests including a + conformance test against the Datalog semantics. +* *The confidence ladder* is a genuine honesty mechanism, not decoration. Only + `Measured`/`Calibrated` may block; carbon is never labelled better than + `Estimated` because the runner's region is unknown; and a test asserts the + ladder rather than trusting convention. +* *SARIF output* is schema-valid and demonstrably ingestible — 101 results + accepted by GitHub code scanning on the `enaction-engine` pilot. The + schema-invalid `fixes[]` block that had made *every* prior upload rejected was + removed in https://github.com/hyperpolymath/oikosbot/pull/45[#45], with a + regression test. +* *Snapshot analysis is deterministic* — two independent `analyse` runs over + frozen staging produce byte-identical `analysis.json`. + +== Method + +Compiled by direct inspection on 2026-08-07: `grep`/`find` over the working +tree at `fix/path-keyed-gate-detection`, `gh` queries against the live +repository for CI and issue state, and `jq` over +`snapshots/2026-08-03/analysis.json` in +https://github.com/hyperpolymath/oikosbot-estate[`hyperpolymath/oikosbot-estate`]. +Claims sourced from earlier sessions were re-verified before being repeated +here; anything that could not be re-verified was dropped rather than restated. diff --git a/GOVERNANCE.md b/GOVERNANCE.md deleted file mode 100644 index e27364c..0000000 --- a/GOVERNANCE.md +++ /dev/null @@ -1,60 +0,0 @@ -# Governance - -## Overview - -This project is governed by the following principles and structures to ensure transparent, inclusive, and effective decision-making. - -## Roles and Responsibilities - -### Maintainers - -Maintainers are responsible for: -- Reviewing and merging pull requests -- Managing releases and versioning -- Ensuring code quality and standards -- Triaging issues and bug reports -- Community engagement and support - -### Contributors - -Contributors are expected to: -- Follow the code of conduct -- Submit well-documented pull requests -- Write tests for new functionality -- Maintain existing tests -- Update documentation as needed - -## Decision Making - -### Minor Changes -- Can be made by any maintainer -- Include bug fixes, documentation updates, dependency updates - -### Major Changes -- Require discussion in issues or pull requests -- Include new features, architectural changes, API changes -- Need approval from at least 2 maintainers - -### Breaking Changes -- Require RFC (Request for Comments) process -- Need approval from majority of maintainers -- Must include migration guide - -## Code of Conduct - -All participants are expected to follow our Code of Conduct. Violations can be reported to the maintainers. - -## Communication - -- **Issues**: For bug reports and feature requests -- **Discussions**: For questions and general discussion -- **Pull Requests**: For code contributions - -## Licensing - -All contributions are made under the terms of the repository's LICENSE file. -By submitting a pull request, you agree to license your contributions accordingly. - ---- - -*Last updated: 2026-07-18* diff --git a/LICENSES/AGPL-3.0-or-later.txt b/LICENSES/AGPL-3.0-or-later.txt deleted file mode 100644 index be3f7b2..0000000 --- a/LICENSES/AGPL-3.0-or-later.txt +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/README.adoc b/README.adoc index 57d13ee..3996d6f 100644 --- a/README.adoc +++ b/README.adoc @@ -8,10 +8,17 @@ v0.1.0-dev :icons: font :source-highlighter: rouge -image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity[OpenSSF Best Practices,link="https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/oikosbot"] image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"] +image:https://img.shields.io/badge/status-alpha-orange.svg[Status: alpha] -*A code-analysis GitHub/GitLab App that adds ecological and economic review to pull requests.* +*Measures what software costs — in money, time, energy and carbon — and which +repositories turn that spend into verified capability.* + +OikosBot analyses code and CI history through an *ecological and economic* lens. +It is unusual in two ways: it treats the *economic* axes as seriously as the +ecological ones, and it starts from *Pareto optimality* rather than a single +score — a change is an improvement only if it dominates, and a trade-off is +named as a trade-off. [NOTE] ==== @@ -36,23 +43,60 @@ toc::[] For a map of all documentation — grouped by audience (developer / maintainer / end-user) and by concept — see link:docs/README.adoc[`docs/README.adoc`]. +== Two units of analysis + +OikosBot works at two scales, and they have very different evidential strength. + +[cols="1,3,3"] +|=== +| | *Per file* (`analyze` / `check` / `report` / `compare`) | *Per estate* (`estate collect` / `analyse` / `report`) + +| Question +| Did this change dominate its base, or trade off? +| Which repositories turn spend into verified capability — and which consume input and produce none? + +| Inputs +| tree-sitter AST metrics +| GitHub CI telemetry: billable minutes, wall-clock, runner class + +| Confidence +| `Estimated` only +| `Measured` money and time; `Calibrated` energy; `Estimated` carbon + +| Can it block? +| No — see the caveat below +| Not yet; round one is read-only by design +|=== + +The estate view exists because *allocative efficiency is not a property of a +single change*. It means scarce resources flow to their highest-valued +competing use; with one diff in front of you there is nothing to allocate +between. Opportunity cost and marginal analysis need a portfolio, so the +portfolio is the unit. + == Status -`v0.1.0` — **online in CI/Action mode**. Full picture: -link:docs/STATUS.adoc[`docs/STATUS.adoc`] (human) and -link:.machine_readable/6a2/STATE.a2ml[`STATE.a2ml`] (machine). +`v0.1.0` — **online in CI/Action mode**; estate pipeline **shipped, read-only**. +Full picture: link:docs/STATUS.adoc[`docs/STATUS.adoc`] (human), +link:.machine_readable/6a2/STATE.a2ml[`STATE.a2ml`] (machine), and +link:DEBT.adoc[`DEBT.adoc`] (what is owed). -Working: the Pareto engine (`crates/oikosbot-pareto`), the published container +Working: the Pareto engine (`crates/oikosbot-pareto`), the estate pipeline +(`oikosbot-telemetry` / `-capability` / `-dea`), the published container `ghcr.io/hyperpolymath/oikos`, the composite GitHub Action, `.oikos.yml` configuration, and SARIF output that GitHub code scanning ingests. [IMPORTANT] ==== -**Every resource figure is a heuristic estimate and `--check` cannot block a -merge.** Only `Measured`/`Calibrated` inputs may fail a run, and the analyzer +**Per-file resource figures are heuristic estimates and `--check` cannot block a +merge.** Only `Measured`/`Calibrated` inputs may fail a run, and the analyser emits only `Estimated` — calibration exists but is not yet wired in (issue -\#48). OikosBot warns loudly rather than passing silently, but treat it as an -advisor, not a regulator. See link:docs/STATUS.adoc[`docs/STATUS.adoc`]. +\#48). OikosBot warns loudly rather than passing silently, but treat the +per-file verdict as an advisor, not a regulator. + +The *estate* path is the exception: `wall_minutes` comes straight from the +GitHub API and is genuinely `Measured`. See link:DEBT.adoc[`DEBT.adoc`] for the +full account of what is and is not earned. ==== The Rust analysis workspace (`crates/oikosbot-*`: CLI, analysis engine, metrics, @@ -80,9 +124,13 @@ The Haskell analyzer scaffold (`analyzers/code-haskell/`) builds independently. ---- oikosbot/ |-- crates/ # Rust workspace (oikosbot-* analysis engine + CLI) -| |-- oikosbot-cli/ # `oikosbot` binary (analyze / check / report) +| |-- oikosbot-cli/ # `oikosbot` binary (analyze/check/report/compare/estate) | |-- oikosbot-analysis/ # tree-sitter analysis + eco/econ heuristics -| |-- oikosbot-metrics/ # shared metric/result types +| |-- oikosbot-metrics/ # shared metric/result types + confidence ladder +| |-- oikosbot-pareto/ # epsilon-tolerant dominance, frontier, verdicts +| |-- oikosbot-telemetry/ # estate: gh-API collector, parquet snapshots, derived metrics +| |-- oikosbot-capability/ # estate: verified-capability output metrics +| |-- oikosbot-dea/ # estate: Data Envelopment Analysis (CCR/BCC LPs) | |-- oikosbot-sarif/ # SARIF report generation | |-- oikosbot-eclexia/ # Eclexia (.ecl) policy evaluation | `-- oikosbot-fleet/ # OPTIONAL gitbot-fleet bridge (excluded by default) @@ -94,8 +142,9 @@ oikosbot/ |-- databases/ontology/ # eco.ttl — VeriSimDB semantic-witness ontology seed |-- examples/ # Example CI integration |-- fuzz/ # cargo-fuzz targets (excluded from the workspace) -|-- docs/ # GITHUB_APP_SETUP.adoc, tech-debt audit -|-- ARCHITECTURE.adoc # Platform architecture (target design) +|-- docs/ # documentation map, status, setup guides, specs +|-- ARCHITECTURE.adoc # Platform architecture (TARGET design — see DEBT.adoc) +|-- DEBT.adoc # Debt register: licence / docs / code / proof / CI-CD |-- DISAMBIGUATION.adoc # oikos vs OikosBot vs sustainabot |-- QUICKSTART.adoc # CLI quickstart `-- DEPLOY.adoc # Deployment status and runbook notes @@ -161,6 +210,50 @@ link:examples/oikosbot-ci.yml[`examples/oikosbot-ci.yml`]. How OikosBot relates to the nearest Marketplace neighbour: link:docs/COMPARISON-climate-warrior.adoc[OikosBot vs Climate Warrior]. +== Estate analysis + +Treats a whole GitHub organisation as a portfolio competing for one budget of +minutes, money, energy and carbon. + +[source,shell] +---- +oikosbot estate collect --owner --out [--max-runs 200] +oikosbot estate analyse --staging --snapshot +oikosbot estate report --snapshot [--format md|json] [-o FILE] +---- + +`collect` reads CI run history through the authenticated `gh` CLI — no +instrumentation in the measured repos, and it works retroactively. It is +resumable: a staging file that already exists is skipped, so an interrupted +sweep can simply be re-run. + +`analyse` derives per-repo cost and capability, then runs *Data Envelopment +Analysis* — input-oriented CCR and BCC solved as linear programs. DEA compares +units with multiple incommensurable inputs *and* outputs, needs no prices, and +returns three things: an efficiency score, the *peer set* (which frontier repos +this one is measured against — an exemplar, not just a number), and the LP +*duals*, which are shadow prices derived from the estate's own data. + +The output measure is *verified capability*, not activity: does a workflow +parse, can a gate actually fail, do artefacts publish. That reframes a familiar +pathology as an economic one — a repository burning CI minutes on a gate with +hundreds of successes and no failure in its entire history is consuming real +input for no verified output. + +Snapshots are versioned Parquet committed to a separate dataset repository, +https://github.com/hyperpolymath/oikosbot-estate[`hyperpolymath/oikosbot-estate`], +so history is git history and the analysis never silently measures a corpus +containing itself. Two `analyse` runs over the same staging produce +byte-identical output. + +[NOTE] +==== +Round one is deliberately *read-only*: it reports, it does not gate. The +premise was checked before anything was built on it — measured correlation +between compute time and code volume across 381 repositories is −0.049, i.e. +the axes really are independent rather than one variable in disguise. +==== + == GitHub App The app manifest lives at link:.github/app.yml[`.github/app.yml`]. The setup diff --git a/ROADMAP.adoc b/ROADMAP.adoc index 22ffd95..1a3c12d 100644 --- a/ROADMAP.adoc +++ b/ROADMAP.adoc @@ -43,8 +43,48 @@ Status legend: `done` | `in-progress` | `blocked` | `planned` access for this repo (`permission_denied: write_package`); fixed by owner grant, not by code — the Containerfile was verified sound via local podman +=== Done (2026-08-03) — estate economics, round one + +* [x] *New unit of analysis: the estate.* Crates `oikosbot-telemetry` + (gh-API collector, Parquet snapshots, derived energy/carbon/cost with the + confidence ladder), `oikosbot-capability` (verified-capability output metrics + including fake-gate detection from run history), `oikosbot-dea` (Data + Envelopment Analysis — input-oriented CCR and BCC as paired + envelopment/multiplier LPs on `good_lp`+HiGHS, returning θ, peer reference + sets and dual weights). PR #60. +* [x] `oikosbot estate collect|analyse|report` — resumable collection, + deterministic analysis, markdown/JSON reporting. +* [x] Snapshot dataset repository + https://github.com/hyperpolymath/oikosbot-estate[`oikosbot-estate`]. +* [x] *First `Measured` data in the project's history* — wall-clock minutes + from the GitHub API. +* [x] Premise falsified before building on it: `pearson(wall_minutes, + size_kb) = -0.049` across 381 repositories. +* [x] CI unblocked — Actions workflow lockfile adopted (#61), reusable-caller + permissions fixed (#63). +* [x] Debt register link:DEBT.adoc[`DEBT.adoc`] and a documentation pass + across README, STATUS, ARCHITECTURE, the a2ml set and the wiki. + === Remaining +*Round two is decided by evidence, not pre-committed.* The candidates are +(A) export the DEA duals as shadow prices and wire Eclexia's currently-inert +`@optimize` through a shared dominance crate; (B) enforcement — wire +`calibration.rs` so `--check` can finally block (#48); (C) deepen the +substrate — stock-flow-consistency identity checks, static capability signals, +longer backfill. The decision criterion is reported by the pipeline itself: +the independence matrix, dual stability across at least two snapshots, and +telemetry coverage. **Requires snapshot #2.** + +* [ ] *Consumer lockfile sweep (P1)* — 15 estate repositories carry + `oikosbot.yml` merged and pinned, but each needs its own Actions lockfile + before the workflow can start. OikosBot is installed everywhere and running + nowhere; this is the highest-value follow-up. +* [ ] *PR decoration (P2)* — a single updated-in-place comment with a verdict + header and honest estimated/measured counts. The one table stake every + comparable product has and OikosBot lacks; SARIF-to-code-scanning is not a + substitute, because it does not gate merges and reviewers do not open the + Security tab during review. Blocked on nothing. * [ ] Stabilize the analyzer request and response schema * [ ] Wire the AffineScript receiver to the analyzer service * [ ] Replace mock health reports with analyzer-backed reports diff --git a/crates/oikosbot-analysis/src/patterns.rs b/crates/oikosbot-analysis/src/patterns.rs index d00bc5f..2181db5 100644 --- a/crates/oikosbot-analysis/src/patterns.rs +++ b/crates/oikosbot-analysis/src/patterns.rs @@ -185,7 +185,7 @@ fn has_busy_wait(source: &str, node: &tree_sitter::Node) -> bool { }; // If the loop body contains any blocking/yielding call, it's not a busy wait - let has_yield = text.contains("sleep") + let has_blocking = text.contains("sleep") || text.contains("await") || text.contains("yield") || text.contains("recv") @@ -193,17 +193,47 @@ fn has_busy_wait(source: &str, node: &tree_sitter::Node) -> bool { || text.contains("wait") || text.contains(".await"); - !has_yield + // Also check for I/O operations that naturally block (not busy-waiting) + let has_io = text.contains(".read(") + || text.contains(".write(") + || text.contains("File::") + || text.contains("BufReader") + || text.contains("BufWriter") + || text.contains("std::io::") + || text.contains("std::fs::"); + + // Check for common non-busy-wait loop patterns + let has_iteration = text.contains("args") && text.contains("match") // Command-line parsing + || text.contains(".iter(") || text.contains(".into_iter(") // Iterator-based loops + || text.contains(".lines(") || text.contains(".split(") // Line/string processing + || text.contains("WalkDir::") || text.contains(".entries(") // Directory traversal + || text.contains(".chars(") || text.contains(".bytes("); // Character/byte processing + + // It's a busy wait only if there's no blocking/yielding, no I/O, AND no legitimate iteration + !(has_blocking || has_io || has_iteration) } /// Check if any loop body contains string concatenation fn has_string_concat_in_loop(source: &str, node: &tree_sitter::Node) -> bool { find_in_loop_body( node, - |child, _src| { - // Look for binary_expression with "+" operator on strings - // or format! macro calls - child.kind() == "binary_expression" || child.kind() == "macro_invocation" + |child, src| { + // Look for binary_expression with "+" or "+=" operator that appears to be string concatenation + if child.kind() == "binary_expression" { + if let Ok(text) = child.utf8_text(src.as_bytes()) { + // Check if this looks like string concatenation: + // - Contains + or += operator + // - Contains string literals (quotes) or String type references + let has_plus = text.contains("+") || text.contains("+="); + let has_strings = text.contains('"') || text.contains("String::"); + return has_plus && has_strings; + } + return false; + } + // Note: We no longer flag macro_invocation (like format!) as these are typically + // used for logging and don't cause the O(n²) string building problem. + // The actual problem is binary expressions like s = s + "text" in loops. + false }, source, ) @@ -233,8 +263,32 @@ fn has_unbuffered_io(source: &str, node: &tree_sitter::Node) -> bool { }; let has_file_io = text.contains("File::open") || text.contains("File::create"); + + if !has_file_io { + return false; + } + let has_buffering = text.contains("BufReader") || text.contains("BufWriter"); + // If there's buffering in the same node (same expression), it's fine + if has_buffering { + return false; + } + + // Check if the File is immediately wrapped with BufReader/BufWriter in a parent expression + // e.g., BufReader::new(File::open(...)) + // We check if there's a call_expression or method_call_expression parent that contains buffering + let mut cursor = node.walk(); + if cursor.goto_parent() { + let parent_text = match cursor.node().utf8_text(source.as_bytes()) { + Ok(t) => t, + Err(_) => return has_file_io && !has_buffering, + }; + if parent_text.contains("BufReader") || parent_text.contains("BufWriter") { + return false; + } + } + has_file_io && !has_buffering } @@ -261,6 +315,7 @@ fn has_large_allocation(source: &str, node: &tree_sitter::Node) -> bool { } /// Check for .to_string() or .to_owned() calls that may be redundant +/// Only flags functions with 5+ allocations to reduce false positives fn has_redundant_to_string(source: &str, node: &tree_sitter::Node) -> bool { let text = match node.utf8_text(source.as_bytes()) { Ok(t) => t, @@ -268,6 +323,7 @@ fn has_redundant_to_string(source: &str, node: &tree_sitter::Node) -> bool { }; // Count occurrences as a heuristic — many .to_string() in one function is suspicious + // Using a higher threshold to reduce false positives let to_string_count = text.matches(".to_string()").count(); let to_owned_count = text.matches(".to_owned()").count(); diff --git a/docs/README.adoc b/docs/README.adoc index 038f848..2650ead 100644 --- a/docs/README.adoc +++ b/docs/README.adoc @@ -1,4 +1,3 @@ -// SPDX-License-Identifier: MPL-2.0 // SPDX-License-Identifier: CC-BY-SA-4.0 // SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell = OikosBot Documentation Map @@ -13,7 +12,14 @@ fleet slot (see link:../DISAMBIGUATION.adoc[DISAMBIGUATION]). * link:../README.adoc[README] — what OikosBot is, and the repo layout. * link:../EXPLAINME.adoc[EXPLAINME] — what is *actually built* vs in-flight. Read this to calibrate expectations. -* link:../ARCHITECTURE.adoc[ARCHITECTURE] — the target platform design, scoring model, and tech stack. +* link:../DEBT.adoc[DEBT] — the debt register: licence, docs, code, proof and CI/CD, each item evidenced. Read alongside EXPLAINME; between them they are the honest account of the project. +* link:../ARCHITECTURE.adoc[ARCHITECTURE] — the *target* platform design, scoring model, and tech stack. Several components in it were never built; the document now flags which. + +== The estate pipeline (newest surface) + +* link:superpowers/specs/2026-08-03-estate-economics-design.md[Design spec] — why the unit of analysis is the estate rather than the diff, and how DEA supplies allocative and productive efficiency. +* link:superpowers/notes/2026-08-03-round-one-verification.md[Verification record] — the six checks round one had to pass, with results, including the falsifier that would have sunk the premise. +* https://github.com/hyperpolymath/oikosbot-estate[`oikosbot-estate`] — the snapshot dataset repository (Parquet + `analysis.json` + rendered report). == For developers diff --git a/docs/STATUS.adoc b/docs/STATUS.adoc index 09fdceb..5d46e72 100644 --- a/docs/STATUS.adoc +++ b/docs/STATUS.adoc @@ -29,12 +29,56 @@ OikosBot is **online in CI/Action mode**. A repository can consume it in three w | CLI | `cargo build --release` → `oikosbot analyze\|check\|report\|compare`. + +| Estate CLI +| `oikosbot estate collect\|analyse\|report` — organisation-scale analysis over + CI telemetry. Read-only; reports, does not gate. |=== Findings reach GitHub's Security tab as SARIF 2.1.0, carrying `pareto_status`, `pareto_score`, `pareto_dominated_by`, `econ_score` and a `confidence` label on every result. +=== The estate pipeline (newest, strongest evidence) + +Shipped 2026-08-03 (PR #60). Three crates — `oikosbot-telemetry`, +`oikosbot-capability`, `oikosbot-dea` — plus the `estate` subcommand. + +It exists because *allocative efficiency is not a property of a single diff*: +scarce resources flowing to their highest-valued competing use requires +competing claims on a shared budget. So the unit of analysis is the whole +estate, and the per-PR check becomes one projection of it. + +What makes it the strongest surface in the project: + +* *The inputs are measured, not modelled.* Wall-clock minutes come straight + from the GitHub API — the first genuinely `Measured` quantity anywhere in + OikosBot. No instrumentation is installed in the analysed repositories, and + history already recorded is available retroactively. +* *The premise was falsified first.* If compute time had turned out to be a + proxy for code volume, the DEA inputs would have been one variable in + disguise. Measured across 381 repositories and 69,445 runs: + `pearson(wall_minutes, size_kb) = -0.049`. Independent. +* *Output is verified capability, not activity* — does a workflow parse, can a + gate actually fail, do artefacts publish. A gate with many successes and no + failure in its whole history has never demonstrated it can fail. +* *DEA gives an exemplar, not just a score.* Each off-frontier repository is + returned with its peer reference set — the frontier repositories it is + measured against — plus the LP duals, which are shadow prices derived from + the estate's own data. +* *Analysis is deterministic:* two runs over the same staging produce + byte-identical `analysis.json`. + +Snapshots live in +https://github.com/hyperpolymath/oikosbot-estate[`hyperpolymath/oikosbot-estate`] +— data only, no code, one directory per collection run, so history is git +history and OikosBot never silently measures a corpus containing itself. + +Round one deliberately does **not** gate. See link:../DEBT.adoc[`DEBT.adoc`] +for its known rough edges (zero-run repositories are absent from the analysis; +zero-output repositories score θ = 0 with empty peer sets, an artefact of +flooring rather than a ranking). + === The Pareto engine The economic core (`crates/oikosbot-pareto`) is real and executable: diff --git a/docs/tech-debt-2026-05-26.adoc b/docs/tech-debt-2026-05-26.adoc index 2c9fc7e..205e3a9 100644 --- a/docs/tech-debt-2026-05-26.adoc +++ b/docs/tech-debt-2026-05-26.adoc @@ -2,6 +2,14 @@ // Copyright (c) Jonathan D.A. Jewell = Tech-Debt Audit — oikos — 2026-05-26 +[WARNING] +==== +*Superseded 2026-08-07 by link:../DEBT.adoc[`DEBT.adoc`].* Kept for the +historical record — it is a point-in-time snapshot of an automated estate scan, +and several of its findings have since been fixed or overtaken. Do not use it +to judge current state. +==== + *Source:* estate-wide automated scan 2026-05-26. *Companion:* https://github.com/hyperpolymath/standards/tree/main/docs/audits[`hyperpolymath/standards` 2026-05-26-estate-*-debt audits]. *Combined severity:* `MEDIUM`.