-
Notifications
You must be signed in to change notification settings - Fork 0
Feat/trustworthy estimate package #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
e21228e
chore(security): protect public repository data
Steel-tech 1a609b0
fix(nest): suppress unsafe burn outputs
Steel-tech c6eaa47
docs(research): validate synthetic workflow premise
Steel-tech c0be4b4
feat(runtime): add shared manifest foundation
Steel-tech 542b24b
feat(nest): publish safe manifested DXF runs
Steel-tech 8d7af95
feat(contracts): add canonical estimate validation
Steel-tech b27b7bf
feat(nest): verify grouped placements and metrics
Steel-tech 164758c
feat(rfq): compile deterministic draft workbooks
Steel-tech 2c17a21
feat(estimate): orchestrate trustworthy package pipeline
Steel-tech ba659bc
ci(release): enforce privacy and provenance gates
Steel-tech abed023
refactor(runtime): simplify shared stage code
Steel-tech ef4df76
fix(review): harden public estimate workflow
Steel-tech 8009363
fix(ci): install DXF runtime and expose draft status
Steel-tech 29862f4
fix(ci): install complete nest runtime
Steel-tech 7102481
fix(ci): pin tested lint and render contracts
Steel-tech File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| pull_request: | ||
| push: | ||
| branches: [main] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| base: | ||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| python-version: ["3.11", "3.13"] | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
| cache: pip | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "20" | ||
| - run: python -m pip install -r requirements.txt -r requirements-dev.txt | ||
| - run: npm test | ||
| - run: npm run lint | ||
| - run: npm run privacy:check | ||
| - run: npm run provenance:check | ||
| - run: npm run pack:check | ||
|
|
||
| full-render: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.12" | ||
| cache: pip | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "20" | ||
| - run: sudo apt-get update && sudo apt-get install -y jq libreoffice poppler-utils | ||
| - run: python -m pip install -r requirements.txt -r requirements-dev.txt -r requirements-render.txt | ||
| - run: npm run test:full | ||
| env: | ||
| PI_STEEL_REQUIRE_FULL_RENDER: "1" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| **/__pycache__/ | ||
| **/*.pyc | ||
| **/company-profile.json | ||
| .pi-steel/ | ||
| private/ | ||
| local-data/ | ||
| customer-data/ | ||
| vendor-data/ | ||
| outputs/ | ||
| out/ | ||
| *.local.json | ||
| *.private.json | ||
| *.xlsx | ||
| *.xls | ||
| *.dxf | ||
| *.png |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| { | ||
| "schema_version": "1.0.0", | ||
| "datasets": [ | ||
| { | ||
| "dataset_id": "aisc-shapes-v16-transformed", | ||
| "shipped_file": "skills/steel-takeoff/assets/aisc-shapes-database.json", | ||
| "claimed_edition": "AISC Shapes Database v16.0", | ||
| "rows": 477, | ||
| "sha256": "5a7c975c4c290c34df6f7df3b4d0d0d13a00ef7c2b1f45097a49a78d245dcc91", | ||
| "required_fields": [ | ||
| "type", | ||
| "designation", | ||
| "weight_per_ft" | ||
| ], | ||
| "redistribution_permission": "unverified", | ||
| "release_readiness": "blocked" | ||
| } | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # Data Provenance | ||
|
|
||
| This file records the evidence and release decision for third-party datasets | ||
| shipped by pi-steel. The repository's MIT license covers StructuPath-authored | ||
| code and documentation; it must not be interpreted as granting rights in | ||
| third-party data. | ||
|
|
||
| [`DATA_PROVENANCE.json`](DATA_PROVENANCE.json) is the machine-readable release | ||
| record checked against the shipped bytes. This document provides the supporting | ||
| human-readable evidence and decision rationale. | ||
|
|
||
| ## AISC shapes database | ||
|
|
||
| | Field | Recorded value | | ||
| | --- | --- | | ||
| | Shipped file | `skills/steel-takeoff/assets/aisc-shapes-database.json` | | ||
| | Claimed edition | AISC Shapes Database v16.0, consistent with the 16th Edition Steel Construction Manual | | ||
| | Rows in shipped JSON | 477 | | ||
| | SHA-256 | `5a7c975c4c290c34df6f7df3b4d0d0d13a00ef7c2b1f45097a49a78d245dcc91` | | ||
| | Upstream description | [AISC Shapes Database v16.0](https://www.aisc.org/aisc/publications/steel-construction-manual/aisc-shapes-database-v160/) | | ||
| | Release evidence | [AISC's August 14, 2023 companion-material announcement](https://www.aisc.org/news/aisc-releases-complementary-materials-for-the-16th-edition-steel-construction-manual/) | | ||
| | Repository introduction | Initial repository commit | | ||
| | Transformation history | Unknown; no source workbook, conversion script, field map, or contemporaneous checksum is present in repository history | | ||
| | Upstream file checksum | Not recorded; the checked-in JSON cannot currently be byte- or row-reconciled to a preserved source workbook | | ||
| | Redistribution permission | Unverified | | ||
| | Release gate | Blocked pending affirmative redistribution evidence or replacement with a dataset whose redistribution terms are documented | | ||
|
|
||
| The upstream pages establish that AISC publishes the v16.0 spreadsheet as a | ||
| downloadable digital supplement and describe its relationship to the 16th | ||
| Edition Manual. They do not, based on the evidence recorded here, grant | ||
| permission to redistribute a transformed copy in another public package. | ||
| Availability without charge is not treated as redistribution permission. | ||
|
|
||
| Until the release gate is resolved: | ||
|
|
||
| - Do not claim that the repository's MIT license covers the shapes data. | ||
| - Do not claim that the checked-in JSON is an independently reproducible | ||
| transformation of the official workbook. | ||
| - Do not publish a new release containing this file without documented approval | ||
| or a documented replacement decision. | ||
| - Continue verifying the recorded checksum so an unexplained data change cannot | ||
| pass unnoticed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Public Data Policy | ||
|
|
||
| This repository is public. Source code, documentation, tests, fixtures, generated | ||
| goldens, commit metadata, issue text, and release artifacts must be safe for public | ||
| distribution. | ||
|
|
||
| ## Allowed | ||
|
|
||
| - Clearly labeled synthetic projects, customers, vendors, people, and identifiers. | ||
| - Published standards data whose source, edition, license, and redistribution rights | ||
| are documented. | ||
| - Invented dimensions and quantities that do not reproduce a private project. | ||
| - Placeholder configuration such as `Example Fabricator` and `Example City, ST`. | ||
| - Product behavior and generic steel-domain terminology. | ||
|
|
||
| ## Prohibited | ||
|
|
||
| - Private company names or identifiers other than the public StructuPath product | ||
| identity. | ||
| - Customer, vendor, employee, subcontractor, or project names and contact details. | ||
| - Real job numbers, drawing references, addresses, schedules, quotes, bids, rates, | ||
| margins, payroll, costs, terms, or contract language. | ||
| - Production drawings, takeoffs, BOMs, nests, RFQs, quotes, reports, screenshots, or | ||
| generated artifacts, including "anonymized" copies derived from them. | ||
| - Company profiles, logos, signatures, credentials, tokens, local absolute paths, or | ||
| exported cloud files. | ||
| - Facts that link this product to a private operating company, facility, customer, or | ||
| internal workflow unless separately approved for publication. | ||
|
|
||
| ## Fixture Rules | ||
|
|
||
| 1. Create fixtures from scratch; do not sanitize production files for public use. | ||
| 2. Prefix project-like identifiers with `SYNTHETIC-` or `EXAMPLE-`. | ||
| 3. Use `Example Customer`, `Example Vendor`, `Example Fabricator`, and | ||
| `Example City, ST` unless a test requires another obviously fictional value. | ||
| 4. Omit prices and commercial terms unless the test specifically requires them. When | ||
| required, label values as synthetic in the same fixture. | ||
| 5. Keep private inputs and generated outputs outside the repository in ignored | ||
| directories such as `private/`, `local-data/`, `customer-data/`, or `outputs/`. | ||
| 6. Run `python3 scripts/check-public-data.py` before every commit and release. Before | ||
| pushing, also scan the outgoing range with | ||
| `python3 scripts/check-public-data.py --range <remote-ref>..HEAD`. | ||
| 7. Put private names and identifiers, one per line, in the ignored local file | ||
| `.pi-steel/private-terms.txt`; the scanner checks them without committing the | ||
| denylist or echoing matched text. | ||
|
|
||
| Git history is public too. Removing a value from the current tree does not remove it | ||
| from prior commits. Use `npm run privacy:history` for a redacted audit; history | ||
| cleanup requires an explicit coordinated rewrite. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.