Skip to content

Commit 4d3e9d3

Browse files
author
Jonathan D.A. Jewell
committed
Add MVP dependencies and best-effort CI
1 parent 7113ba6 commit 4d3e9d3

File tree

5 files changed

+129
-0
lines changed

5 files changed

+129
-0
lines changed

.github/workflows/mvp-smoke.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# SPDX-License-Identifier: AGPL-3.0-or-later
2+
name: MVP Smoke (Best Effort)
3+
4+
on:
5+
push:
6+
branches: [main]
7+
pull_request:
8+
branches: [main]
9+
10+
permissions: read-all
11+
12+
env:
13+
CARGO_TERM_COLOR: always
14+
15+
jobs:
16+
mvp-smoke:
17+
name: MVP Smoke
18+
runs-on: ubuntu-latest
19+
permissions:
20+
contents: read
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
24+
25+
- name: Setup Rust toolchain
26+
uses: dtolnay/rust-toolchain@6d9817901c499d6b02debbb57edb38d33daa680b # stable
27+
with:
28+
toolchain: stable
29+
30+
- name: Cache Cargo
31+
uses: Swatinem/rust-cache@ad397744b0d591a723ab90405b7247fac0e6b8db # v2
32+
33+
- name: Build release
34+
run: cargo build --release
35+
36+
- name: MVP smoke checks (best effort)
37+
run: just --justfile Justfile mvp-env

Justfile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,7 @@ pre-commit: fmt-check lint test
7979
# MVP 1.0 smoke checks
8080
mvp:
8181
./scripts/mvp-smoke.sh
82+
83+
# MVP 1.0 dependency checklist (best-effort)
84+
mvp-env:
85+
./scripts/mvp-smoke.sh || true

README.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,16 @@ just security # Trivy, cargo-audit
188188
just coverage # Test coverage
189189
```
190190

191+
=== MVP Smoke (Best Effort)
192+
193+
```bash
194+
# MVP smoke checks (reports missing provers, does not fail)
195+
just mvp
196+
197+
# Dependency checklist (always non-fatal)
198+
just mvp-env
199+
```
200+
191201
== Documentation
192202

193203
- link:CONTRIBUTING.md[Contributing Guidelines]

docs/MVP-1.0-DEPS.adoc

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
= ECHIDNA MVP 1.0 Dependencies
2+
:toc: macro
3+
:toclevels: 2
4+
5+
This document lists external prover dependencies for the 1.0 MVP and how to verify them.
6+
7+
TOC::[]
8+
9+
== Core Provers (12)
10+
11+
|===
12+
| Prover | Executable | Notes
13+
14+
| Agda
15+
| `agda`
16+
| Install via system package or Agda tooling.
17+
18+
| Coq
19+
| `coqtop`
20+
| Coq/Rocq interactive toplevel.
21+
22+
| Lean
23+
| `lean`
24+
| Lean 4 CLI (elan recommended).
25+
26+
| Isabelle
27+
| `isabelle`
28+
| Isabelle server + tools.
29+
30+
| Z3
31+
| `z3`
32+
| SMT solver.
33+
34+
| CVC5
35+
| `cvc5`
36+
| SMT solver.
37+
38+
| Metamath
39+
| `metamath`
40+
| Metamath verifier.
41+
42+
| HOL Light
43+
| `hol-light`
44+
| HOL Light executable wrapper.
45+
46+
| Mizar
47+
| `mizar`
48+
| Mizar system (verifier + MML).
49+
50+
| PVS
51+
| `pvs`
52+
| PVS environment.
53+
54+
| ACL2
55+
| `acl2`
56+
| ACL2 environment.
57+
58+
| HOL4
59+
| `hol4`
60+
| HOL4 environment.
61+
|===
62+
63+
== Quick Check
64+
65+
Run:
66+
67+
----
68+
just mvp
69+
----
70+
71+
Missing executables are reported explicitly. This is expected on dev machines.
72+
73+
== Optional Helpers
74+
75+
* `just mvp-env` (best-effort checklist) prints what is missing.
76+
* Prefer installing provers locally for full MVP validation.

docs/MVP-1.0.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ TOC::[]
5353

5454
* Script exists to check prover executables are available (or clearly report missing).
5555
* Script runs minimal prove/verify for each prover when available.
56+
* Dependency checklist is documented in `docs/MVP-1.0-DEPS.adoc`.
57+
* Dependency checklist is documented in `docs/MVP-1.0-DEPS.adoc`.
5658

5759
== Release Prep
5860

0 commit comments

Comments
 (0)