* [CI] Adopt GitHub Actions # Motivation We want to adopt GitHub actions in all of our Swift repositories to replace our current Jenkins CI. # Modification This PR adopts the reusable workflows from NIO and the swiftlang organization to ensure soundness and test coverage. Additionally, this PR enables a sematic label check and adds a `release.yml` to make releasing this package easy. # Result Modern CI and release flow.
3.4 KiB
Legal
By submitting a pull request, you represent that you have the right to license
your contribution to Apple and the community, and agree by submitting the patch
that your contributions are licensed under the Apache 2.0 license (see
LICENSE.txt).
How to submit a bug report
Please ensure to specify the following:
- SwiftNIO IMAP commit hash
- Contextual information (e.g. what you were trying to achieve with SwiftNIO IMAP)
- Simplest possible steps to reproduce
- More complex the steps are, lower the priority will be.
- A pull request with failing test case is preferred, but it's just fine to paste the test case into the issue description.
- Anything that might be relevant in your opinion, such as:
- Swift version or the output of
swift --version - OS version and the output of
uname -a - Network configuration
- Swift version or the output of
Example
SwiftNIO IMAP commit hash: 22ec043dc9d24bb011b47ece4f9ee97ee5be2757
Context:
While load testing my IMAP server written with SwiftNIO IMAP, I noticed
that one file descriptor is leaked per request.
Steps to reproduce:
1. ...
2. ...
3. ...
4. ...
$ swift --version
Swift version 4.0.2 (swift-4.0.2-RELEASE)
Target: x86_64-unknown-linux-gnu
Operating system: Ubuntu Linux 16.04 64-bit
$ uname -a
Linux beefy.machine 4.4.0-101-generic #124-Ubuntu SMP Fri Nov 10 18:29:59 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux
My system has IPv6 disabled.
Writing a Patch
A good SwiftNIO IMAP patch is:
- Concise, and contains as few changes as needed to achieve the end result.
- Tested, ensuring that any tests provided failed before the patch and pass after it.
- Documented, adding API documentation as needed to cover new functions and properties.
- Accompanied by a great commit message, using our commit message template.
Commit Message Template
We require that your commit messages match our template. The easiest way to do that is to get git to help you by explicitly using the template. To do that, cd to the root of our repository and run:
git config commit.template dev/git.commit.template
The default policy for taking contributions is “Squash and Merge” - because of this the commit message format rule above applies to the PR rather than every commit contained within it.
Run CI checks locally
You can run the Github Actions workflows locally using act. For detailed steps on how to do this please see https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally.
Make sure your code is performant
SwiftNIO has been created to be high performance. The integration tests cover some measures of performance including allocations which should be avoided if possible. For help with allocation problems refer to the guide to allocation debugging
Extensibility
Try to make sure your code is robust to future extensions. The public interface is very hard to change after release - please refer to the SwiftNIO API guidelines
How to contribute your work
Please open a pull request at https://github.com/apple/swift-nio-imap. Make sure the CI passes, and then wait for code review.
After review you may be asked to make changes. When you are ready, use the request re-review feature of github or mention the reviewers by name in a comment.