Skip to content
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

Add a document to begin collecting pending ABI changes #946

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions Documentation/ABI/Pending-ABIv1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Pending ABIv1 Changes

This document collects changes which have been made and are anticipated to be
released in a future ABI/event stream version, but are still pending.

> [!IMPORTANT]
> This file describes changes which are unreleased, and are subject to change.
> Do not depend on this version or make assumptions that these changes will
> remain part of this ABI version.

## Issue severity and warning issues

Introduced a notion of "severity" for issues, and a new "warning" severity level
which is lower than the default "error" level. Clients upgrading from v0 should
begin consulting the severity of recorded issues to determine whether the
associated test should be marked as failing.

### See Also

- https://github.com/swiftlang/swift-testing/pull/931