Skip to content

docs(sdk): add 2.0 migration guidance to release notes #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.

Sign up for GitHub

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
tbartel74 merged 1 commit into from
Jul 14, 2026
Merged

docs(sdk): add 2.0 migration guidance to release notes #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,19 @@ jobs:
pip install vigil-guard==${{ steps.version.outputs.package_version }}
```

## Migration from 1.x

SDK 2.0 accepts anti-recon opaque responses. Check
`result.diagnostics_available` before reading diagnostic fields or
compare optional diagnostic properties explicitly, such as
`result.is_high_risk is True`.

Before rolling a consumer back to SDK 1.x, disable opaque exposure
for that consumer's affected rule sets. A 1.x parser rejects opaque
responses, so use a forward fix when that cannot be guaranteed.

See `CHANGELOG.md` in this release for the complete migration notes.

## Verification
SBOM is included in release assets. GPG signatures are included when the release signing key is configured.

Expand Down
Loading