chore(conformance): release vector suite version 0.1.0 - #441
Merged
Conversation
Bump SuiteVersion and CryptoSuiteVersion from "0.1.0-draft" to "0.1.0" and regenerate the golden manifests so the published vector set carries a release version rather than a draft one. Only the two manifest.json files change. The vector bytes themselves are version independent: the suite version is written into the manifest index and is not an input to event encoding, whose domain tag is provetrail/event/v1. No .cbor artifact is touched, so a downstream verifier's expected results are unchanged. Signed-off-by: Ion Alpha <contact@ionalpha.io>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
What
Bumps
SuiteVersion(chain/conformance/conformance.go) andCryptoSuiteVersion(chain/conformance/crypto.go) from"0.1.0-draft"to"0.1.0", and regenerates the golden manifests.The whole diff is four lines: the two constants, and the
suite_versionfield intestdata/vectors/manifest.jsonandtestdata/crypto/manifest.json. No.cborartifact is touched.Why
The vector suite is being published downstream as a release rather than a draft, so the version string it carries has to stop saying
-draft. This package is the single source of truth for the vectors, so the bump has to happen here first and be copied outward, never the reverse.The vector bytes are version independent by construction: the suite version is written into the manifest index only, and is not an input to event encoding, whose domain tag is
provetrail/event/v1. That is why no artifact bytes move and a downstream verifier's expected results are unchanged. Any.cborfile appearing in this diff would mean something else changed and the bump should be stopped.How to verify
The golden-match test in
chain/conformanceis what enforces this: it fails if the committed manifests disagree with what the generator produces from the constants, so it covers the change directly../dev/lintand./dev/vulnare clean.Notes for reviewers
Downstream consumers of the published vector set must take this bump before, or together with, their own copy of the manifests. Copying the new manifests downstream while these constants still said
-draftwould fail the golden-match test here, and bumping here without copying outward leaves the downstream copy stale. See TESTING.md ("Conformance vectors") for that ordering.