Skip to content

README: list validation/ and its CLIs - #113

Merged
nickpell merged 1 commit into
mainfrom
nick/openauction-readme-validation
Oct 26, 2026
Merged

nickpell merged 1 commit into
mainfrom
nick/openauction-readme-validation

Conversation

@nickpell

@nickpell nickpell commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

Summary

  • The README's Overview listed core/, enclaveapi/ and enclave/ but not validation/, the package that verifies enclave attestations (PCRs, the AWS Nitro certificate chain, the COSE_Sign1 signature, then the key and auction checks) and that cloudx-io/openarbiter imports. The Overview now lists it along with its two CLIs, validation/cmd/auction-validator and validation/cmd/key-validator, each described from its own usage text and the package's doc comments.
  • The Usage import example now includes github.com/cloudx-io/openauction/validation.

Notes for reviewers

#44 also edits the Overview, rewording the core/ bullet two lines above the new one. A test merge of #44 into this branch merges README.md without a conflict.

Pre-merge checklist

  • Both CLIs exist on main and build: go run ./validation/cmd/key-validator --help and go run ./validation/cmd/auction-validator --help print their usage
  • The updated import block (core, enclaveapi, validation) compiles in a scratch module that replaces github.com/cloudx-io/openauction with this branch
  • go build ./... and go vet ./... pass; the change touches README.md only, so the enclave binary is unchanged
  • Go and Ratchet workflows green on this branch: lint, test, docker-build and Ratchet Lint pass on e708b63
  • Diff contains no unintended changes: README.md only

Post-deploy/apply verification

  • The main pipeline on the merge commit is green: Go, then Docker Build, then Build EIF, then the [skip-build] Update PCR measurements commit (d2cfa57: Go 40377103017, Docker Build 40377190762, Build EIF 40377811105 all success; PCR commit 1400a25)

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation matches the existing validation APIs and CLI usage, with no blocking issues identified.

No open issues 🎉

What changed in this PR

This documentation-only PR makes the existing attestation validation package and its command-line tools discoverable in the README.

Changes:

  • Describe validation/, its verification responsibilities, and its use by openarbiter.
  • List the auction-validator and key-validator CLIs.
  • Add validation to the Usage import example.
File Description
README.md Document the validation package and CLIs, and extend the import example.

Review effort: Balanced

@nickpell
nickpell merged commit d2cfa57 into main Oct 26, 2026
5 checks passed
@nickpell
nickpell deleted the nick/openauction-readme-validation branch October 26, 2026 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants