mirror of
https://github.com/apple/swift-certificates
synced 2026-11-22 04:20:39 +00:00
### Motivation: We now have centrally-hosted CMake checks in the NIO repository which we should use to reduce maintenance. The new checks also increase coverage by performing a build with CMake as part of the checks. ### Modifications: * Use the new workflow * Commit formatting changes in the CMakeLists files from the new script * Document how to update the CMakeLists files * Remove the obsolete scripts ### Result: Better CI coverage.
84 lines
3.6 KiB
Markdown
84 lines
3.6 KiB
Markdown
## 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:
|
|
|
|
* Commit hash
|
|
* Contextual information (e.g. what you were trying to achieve with swift-certificates)
|
|
* 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
|
|
|
|
### Example
|
|
|
|
```
|
|
Commit hash: b17a8a9f0f814c01a56977680cb68d8a779c951f
|
|
|
|
Context:
|
|
While testing my application that uses with swift-certificates, I noticed that ...
|
|
|
|
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 patch is:
|
|
|
|
1. Concise, and contains as few changes as needed to achieve the end result.
|
|
2. Tested, ensuring that any tests provided failed before the patch and pass after it.
|
|
3. Documented, adding API documentation as needed to cover new functions and properties.
|
|
4. 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
|
|
|
|
### Run CI checks locally
|
|
|
|
You can run the Github Actions workflows locally using
|
|
[act](https://github.com/nektos/act). For detailed steps on how to do this please see [https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally](https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally).
|
|
|
|
### How to update CMakeLists files
|
|
|
|
If you wish to update the CMakeLists files you can either do this by using [act](https://github.com/nektos/act) or calling the remotely hosted CI script.
|
|
|
|
Issuing a command such as the following to `act` causes it to run the `cmake-lists` job locally which updates the CMakeLists files and if it finds no changes performs a build. The `--bind` flag means that the VM be acts on your local filesystem so be aware that this could delete/change files (including your git setup/branches).
|
|
```
|
|
act --container-architecture linux/amd64 pull_request -j cmake-lists -W ./.github/workflows/pull_request.yml --bind
|
|
```
|
|
|
|
You can find the underlying script at https://github.com/apple/swift-nio/blob/main/scripts/update-cmake-lists.sh . Using the script directly is less straightforwards because it requires you to pass the JSON config from the `pull_request.yml` file into the script, such as:
|
|
```
|
|
curl -s https://raw.githubusercontent.com/apple/swift-nio/main/scripts/update-cmake-lists.sh | CONFIG_JSON='{"targets":[{"name":"X509","type":"source","exceptions":[]},{"name":"_CertificateInternals","type":"source","exceptions":[]}]}' bash
|
|
|
|
## How to contribute your work
|
|
|
|
Please open a pull request at https://github.com/apple/swift-certificates. Make sure the CI passes, and then wait for code review.
|