Skip to content

Commit 49d50f7

Browse files
author
Nathan Gillett
committed
ci(docs): add intentproof-spec conformance (CI + tox), changelog, README
1 parent fe7bbd5 commit 49d50f7

6 files changed

Lines changed: 176 additions & 80 deletions

File tree

.github/workflows/ci.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,24 @@ concurrency:
1010
cancel-in-progress: true
1111

1212
jobs:
13+
intentproof-spec:
14+
runs-on: ubuntu-latest
15+
timeout-minutes: 15
16+
steps:
17+
- uses: actions/checkout@v4
18+
with:
19+
repository: intentproof/intentproof-spec
20+
path: intentproof-spec
21+
22+
- uses: actions/setup-node@v4
23+
with:
24+
node-version-file: intentproof-spec/.nvmrc
25+
cache: npm
26+
cache-dependency-path: intentproof-spec/package-lock.json
27+
28+
- name: Canonical spec conformance (Vitest oracle)
29+
run: bash intentproof-spec/scripts/run-conformance.sh intentproof-spec
30+
1331
audit:
1432
runs-on: ubuntu-latest
1533
steps:

CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Changelog
2+
3+
Repository: [IntentProof Python SDK (`intentproof-sdk-python`)](https://github.com/intentproof/intentproof-sdk-python).
4+
5+
All notable changes to this repository are documented here. **PyPI** releases use SemVer for the **`intentproof-sdk`** distribution (`version` in [`pyproject.toml`](pyproject.toml)); tag releases in Git to match published versions.
6+
7+
## Unreleased
8+
9+
- **Security:** upgrade **pip** to **≥26.1** after Python setup in the composite **`.github/actions/setup-python-pip`** action, and in the default **`[testenv]`** via **`commands_pre`**, addressing **CVE-2026-3219** and **CVE-2026-6357**.
10+
- **CI:** add **`intentproof-spec`** job—checkout [`intentproof-spec`](https://github.com/intentproof/intentproof-spec) and run **`scripts/run-conformance.sh`** (canonical Vitest conformance oracle).
11+
- **Local spec checks:** add **`scripts/spec-conformance.sh`** and **`tox -e spec`** (sibling **`../intentproof-spec`** or **`INTENTPROOF_SPEC_ROOT`**).
12+
- **Docs:** add this **`CHANGELOG.md`** (aligned with the [spec repo changelog](https://github.com/intentproof/intentproof-spec/blob/main/CHANGELOG.md)); refresh **`README.md`**—positioning, pinned PyPI/GitHub install guidance, reorganized API reference tables, **`intentproof-spec`** section, vulnerability reporting link, and related edits.
13+
- **Packaging metadata:** update **`description`** and **`keywords`** in **`pyproject.toml`**.
14+
- **Repo layout:** remove **`.gitlab-ci.yml`** (GitLab CI mirror).
15+
16+
## 0.1.0 — 2026-05-04
17+
18+
- **`intentproof`** package: client, **`wrap`** / capture helpers, **`HttpExporter`**, correlation utilities.
19+
- **Quality:** **tox** environments for **ruff**, pytest with a **100%** line-coverage gate, and a multi-Python (**3.11–3.14**) test matrix.
20+
- **CI:** GitHub Actions workflows for **`pip-audit`** and **tox**; composite action to set up Python and cache **pip**/**tox** dependencies. Repository included an optional **`.gitlab-ci.yml`** mirroring those checks for GitLab.

0 commit comments

Comments
 (0)