### Motivation:
A bit confusing to see docker mentioned in Readme file, when in reality
you can't run docker compose anymore.
### Modifications:
Updated README and CONTRIBUTING files, removed some scripts.
### Result:
No mentions of docker so users are not confused.
Co-authored-by: Rick Newton-Rogers <rnro@apple.com>
Updates to documentation comments in `NIOFileSystem`.
### Motivation:
I've been reviewing some parts of `NIOFileSystem` and came across a
variety of formatting of documentation comments.
### Modifications:
I've adopted a stricter 100-character limit (arbitrary, really; it could
be longer or shorter and is totally not consistent with the rest of the
repository). Also updated a bunch of grammar in comments. Fixed a few
typos along the way.
### Result:
- Updated comments have a better flow while reading, and aren't as
abrupt as before.
- Fewer typos in comments
---------
Co-authored-by: Cory Benfield <lukasa@apple.com>
Motivation:
The contibuting guide gives an incorrect command to run to invoke the
formatting job locally.
Modifications:
- Change the job name to 'soundness'
- Add a note about setting the container architecture
Result:
Better docs
Trying to fix swift format link in contributions.md
Someone please let me know what the process is for running `swift
format` locally now that the script has been moved out of the repo.
Co-authored-by: Franz Busch <f.busch@apple.com>
# Motivation
We only support the last three Swift released versions which are at this
time 5.9, 5.10 and 6.
# Modification
This PR drops anything related to Swift 5.8.
# Result
Version support aligned.
Make sure repository docs represent the current status quo
Motivation:
Some parts of the docs were out of date and confusing/wrong.
Modifications:
Made references to supported versions appropriate for the current mainline version supported (5.10) and the retained support for 5.9 and 5.8.
In addition made that operating mode an explicit statement of commitment, along with the use of nightlies of pre release versions..
Now that more checks are present as GitHub Actions they are easier for users to run directly with act, so provided some links and one liners to do that.
The old references to swift-format were no longer hopeful, they became true!
Added myself as a committer at the same time
Result:
Docs should be more accurate and helpful. Intent of the matrix for support should be clearer
Motivation:
This is no longer needed in the currently supported versions of swift.
Advice is misleading as script no longer exists.
Modifications:
Remove contributing advice to generate linux tests.
Result:
Happy contributors, less confusion.
* Bump minimum Swift version to 5.7
Motivation:
Now that Swift 5.9 is GM we should update the supported versions and
remove 5.6
Modifications:
* Update `Package.swift`
* Remove `#if swift(>=5.7)` guards
* Delete the 5.6 docker compose file and make a 5.10 one
* Update integration test script
* Update docs
Result:
Remove support for Swift 5.6, add 5.10
* fix indentation issues
* 5.9 docker image use release image
Motivation:
SwiftNIO periodically drops support for older Swift versions. Now that
5.7 has been released, 5.4 will be dropped.
Modifications:
- Remove 5.4 specific Package.swift and docker-compose
- Update the 5.7 docker-compose to use the released 5.7 and move from
focal (2004) to jammy (2204)
- Remove unused swiftformat from Dockerfile
- Update tools version in syscall wrapper tests to 5.5
- Update docs
Results:
Minimum Swift version is 5.5
* Drop support for 5.2 and 5.3
As outlined in a [Swift forums post in November ’21](https://forums.swift.org/t/swiftnio-swift-version-support/53232), SwiftNIO will only support the latest non-patch Swift release and the 2 immediately prior non-patch versions.
In this commit we drop support for Swift 5.2 and 5.3. We update CI for Swift 5.4 to run on bionic instead of focal to ensure that we still test bionic.
* Added Versions paragraph to Security document
* Apply suggestions from code review
Co-authored-by: Cory Benfield <lukasa@apple.com>
Co-authored-by: Cory Benfield <lukasa@apple.com>
Make Swift 5.2 the minimum requirement, dropping support for Swift 5.0 and 5.1.
Motivation:
Whenever we have problems, Swift 5.0 and 5.1 seem to be the culprits. Dropping support for these very old versions will require less maintenance and free up our time to work on new features.
Modifications:
Set the tools version in Package.swift to 5.2
Remove CI configurations for 5.0 and 5.1
Update the various readmes to reflect that this change will be rolled out in NIO 2.30.0
Result:
Swift 5.2 is the minimum version of Swift required to use NIO.
Motivation:
It is unclear how to engage with the core team after changes have been requested.
Modifications:
Add a short note to the CONTRIBUTING guide.
Result:
Increased clarity on how to interact.
Motivation:
The more contributors know what's expected of them upfront the less likely they are to consume reviewer time and experience a harsh review.
Modifications:
Add some extra commentary to CONTRIBUTORS.md
Add a docker compose example with specific ubuntu/swift versions to README.md
Result:
Contributors will be more informed.
Co-authored-by: Cory Benfield <lukasa@apple.com>
Motivation:
The path of the script to invoke was wrong,
also highlight that this is absolutely required
for a PR.
Modifications:
Some bold, some text, some proper path.
Result:
CI will be super happy as less people will
fail to generate proper Linux tests.
Jaleel AkbashevandRick Newton-Rogers
Michael GechtandCory Benfield
George Barnett
Ali AliandFranz Busch
Matt Hope
Peter Adams
Rick Newton-Rogers
David Nadoba
Fabian FettandCory Benfield
David Evans
Helge Heß
Johannes Weiß