Skip to content

Update CI triggers in CONTRIBUTING.md #8187

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

Merged
merged 2 commits into from
Jan 17, 2025
Merged

Update CI triggers in CONTRIBUTING.md #8187

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
967e33c
Update CI triggers in CONTRIBUTING.md
shahmishal Dec 20, 2024
a098e45
Address feedback
plemarquand Jan 3, 2025
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
15 changes: 9 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,19 +336,14 @@ license](https://swift.org/LICENSE.txt).

SwiftPM uses [swift-ci](https://ci.swift.org) infrastructure for its continuous integration testing. The bots can be triggered on pull-requests if you have commit access. Otherwise, ask one of the code owners to trigger them for you.

To run smoke test suite with the trunk compiler and other projects use:

```
@swift-ci please smoke test
```

This is **required** before a pull-request can be merged.


To run just the self-hosted test suite (faster turnaround times so it can be used to get quick feedback) use:

```
@swift-ci please smoke test self hosted
@swift-ci please test self hosted
```


Expand All @@ -358,13 +353,21 @@ To run the swift toolchain test suite including SwiftPM use:
@swift-ci please test
```

To run the swift toolchain test suite against a specific platform use one of the following:

```
@swift-ci please test macos
@swift-ci please test linux
@swift-ci please test windows
```

To run package compatibility test suite (validates we do not break 3rd party packages) use:

```
@swift-ci please test package compatibility
```


## Generating Documentation

SwiftPM uses [DocC](https://github.com/apple/swift-docc) to generate some of its documentation (currently only the `PackageDescription` module). Documentation can be built using Xcode's GUI (Product → Build Documentation or `⌃⇧⌘D`) or manually:
Expand Down