Skip to content

Commit 33fc5e5

Browse files
authored
Add README and .spi.yml (#6)
1 parent 10725f0 commit 33fc5e5

File tree

6 files changed

+36
-133
lines changed

6 files changed

+36
-133
lines changed

Diff for: .spi.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
version: 1
2+
builder:
3+
configs:
4+
- documentation_targets: [GRPCHealthService, GRPCInterceptors]
5+
swift_version: 6.0

Diff for: CONTRIBUTING.md

+3-18
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,4 @@
1-
# How to contribute
1+
# Contributing
22

3-
We definitely welcome patches and contributions to grpc-swift! Please read the gRPC
4-
organization's [governance rules](https://github.com/grpc/grpc-community/blob/main/governance.md)
5-
and [contribution guidelines](https://github.com/grpc/grpc-community/blob/main/CONTRIBUTING.md) before proceeding.
6-
7-
Here are some guidelines and information about how to participate.
8-
9-
## Getting started
10-
11-
### Legal requirements
12-
13-
In order to protect both you and ourselves, you will need to sign the
14-
[Contributor License Agreement](https://identity.linuxfoundation.org/projects/cncf).
15-
16-
### Technical requirements
17-
18-
Please see the [main gRPC repository](https://github.com/grpc/grpc) for
19-
more information about gRPC.
3+
Please refer to the contributing guide in the
4+
[`grpc/grpc-swift`](https://github.com/grpc/grpc-swift) repository.

Diff for: NOTICES.txt

-71
This file was deleted.

Diff for: README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# gRPC Swift Extras
2+
3+
This repository contains optional extras for [gRPC Swift][gh-grpc-swift].
4+
5+
- 📚 **Documentation** is available on the [Swift Package Index][spi-grpc-swift-extras]
6+
- 🎓 **Tutorials** are available in the documentation for `grpc/grpc-swift` on
7+
the [Swift Package Index][spi-grpc-swift].
8+
- 💻 **Examples** are available in the `Examples` directory of the
9+
[`grpc/grpc-swift`](https://github.com/grpc/grpc-swift) repository
10+
- 🚀 **Contributions** are welcome, please see [CONTRIBUTING.md](CONTRIBUTING.md)
11+
- 🪪 **License** is Apache 2.0, repeated in [LICENSE](License)
12+
- 🔒 **Security** issues should be reported via the process in [SECURITY.md](SECURITY.md)
13+
14+
[gh-grpc-swift]: https://github.com/grpc/grpc-swift
15+
[spi-grpc-swift-extras]: https://swiftpackageindex.com/grpc/grpc-swift-extras/documentation

Diff for: SECURITY.md

+2-44
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,4 @@
11
# Security
22

3-
This document specifies the security process for gRPC Swift.
4-
5-
## Disclosures
6-
7-
### Private Disclosure Process
8-
9-
The gRPC Swift team asks that known and suspected vulnerabilities be
10-
privately and responsibly disclosed by emailing
11-
12-
with the [details usually included with bug reports][issue-template].
13-
**Do not file a public issue.**
14-
15-
#### When to report a vulnerability
16-
17-
* You think you have discovered a potential security vulnerability in gRPC
18-
Swift.
19-
* You are unsure how a vulnerability affects gRPC Swift.
20-
21-
#### What happens next?
22-
23-
* A member of the team will acknowledge receipt of the report within 3
24-
working days (United Kingdom). This may include a request for additional
25-
information about reproducing the vulnerability.
26-
* We will privately inform the Swift Server Work Group ([SSWG][sswg]) of the
27-
vulnerability within 10 days of the report as per their [security
28-
guidelines][sswg-security].
29-
* Once we have identified a fix we may ask you to validate it. We aim to do this
30-
within 30 days. In some cases this may not be possible, for example when the
31-
vulnerability exists at the protocol level and the industry must coordinate on
32-
the disclosure process.
33-
* If a CVE number is required, one will be requested from [MITRE][mitre]
34-
providing you with full credit for the discovery.
35-
* We will decide on a planned release date and let you know when it is.
36-
* Prior to release, we will inform major dependents that a security-related
37-
patch is impending.
38-
* Once the fix has been released we will publish a security advisory on GitHub
39-
and the [SSWG][sswg] will announce the vulnerability on the [Swift
40-
forums][swift-forums-sec].
41-
42-
[issue-template]: https://github.com/grpc/grpc-swift/blob/main/.github/ISSUE_TEMPLATE/BUG_REPORT.md
43-
[sswg]: https://github.com/swift-server/sswg
44-
[sswg-security]: https://github.com/swift-server/sswg/blob/main/process/incubation.md#security-best-practices
45-
[swift-forums-sec]: https://forums.swift.org/c/server/security-updates/
46-
[mitre]: https://cveform.mitre.org/
3+
Please refer to [SECURITY.md] in the
4+
[`grpc/grpc-swift`](https://github.com/grpc/grpc-swift) repository.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ``GRPCHealthService``
2+
3+
This module contains an implementation of the gRPC Health service
4+
("grpc.health.v1.Health").
5+
6+
## Overview
7+
8+
The gRPC Health service is a regular gRPC service which allows clients to
9+
request the status of another service. This can be done by polling the server
10+
(the "Check" RPC) or by subscribing for changes to the status of a service (the
11+
"Watch" RPC).

0 commit comments

Comments
 (0)