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.

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

Add compatibility doc #2123

Merged
merged 4 commits into from
Nov 20, 2024
Merged

Add compatibility doc #2123

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c200e99
Add compatability doc
glbrntt Nov 20, 2024
d227e9e
Apply suggestions from code review
glbrntt Nov 20, 2024
ecde035
Merge branch 'main' into v2/supported-versions
glbrntt Nov 20, 2024
9cd408c
Merge branch 'main' into v2/supported-versions
glbrntt Nov 20, 2024
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
22 changes: 22 additions & 0 deletions Sources/GRPCCore/Documentation.docc/Articles/Compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Compatibility

Learn which versions of Swift are supported by gRPC Swift and how this changes
over time.

## Overview

### Supported Swift Versions

gRPC Swift supports the **three most recent Swift versions** which are **Swift 6
glbrntt marked this conversation as resolved.
Show resolved Hide resolved
or newer**. Within a minor Swift release only the latest patch version is supported.

| grpc-swift | Minimum Supported Swift version |
|------------|---------------------------------|
| 1.0 | 6.0 |
glbrntt marked this conversation as resolved.
Show resolved Hide resolved

### Platforms

gRPC Swift aims to support the same platforms as Swift project. These are listed
on [swift.org](https://www.swift.org/platform-support/).

The only known unsupported platform from that list is currently Windows.
czechboy0 marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 4 additions & 0 deletions Sources/GRPCCore/Documentation.docc/Documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ as tutorials.

- <doc:Generating-stubs>

### Project Information

- <doc:Compatibility>

### Getting involved

Resources for developers working on gRPC Swift:
Expand Down
Loading