Skip to content

Commit 5399e73

Browse files
authored
Merge pull request swiftlang#12363 from apple/ci-doc-compiler-performance
[doc] Document "please test compiler performance"
2 parents 678a670 + f8e7e4b commit 5399e73

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/ContinuousIntegration.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,22 @@ preset=buildbot_incremental,tools=RA,stdlib=RD,smoketest=macosx,single-thread
148148
149149
```
150150

151+
### Testing Compiler Performance
152+
153+
Platform | Comment | Check Status
154+
------------ | ------- | ------------
155+
macOS platform | @swift-ci Please test compiler performance | Compiles full source compatibility test suite and measures compiler performance
156+
macOS platform | @swift-ci Please smoke test compiler performance | Compiles a subset of source compatibility test suite and measures compiler performance
157+
158+
These commands will:
159+
160+
1. Build a set of projects from the compatibility test suite
161+
2. Collect counters and timers reported by the compiler
162+
3. Compare the obtained data to the baseline (stored in git) and HEAD (version of a compiler built without the PR changes)
163+
4. Report the results in a pull request comment
164+
165+
For the detailed explanation of how compiler performance is measured, please refer to [this document](https://github.com/apple/swift/blob/master/docs/CompilerPerformance.md).
166+
151167
## Cross Repository Testing
152168

153169
Simply provide the URL from corresponding pull requests in the same comment as "@swift-ci Please test" phrase. List all of the pull requests and then provide the specific test phrase you would like to trigger. Currently, it will only merge the main pull request you requested testing from as opposed to all of the PR's.

0 commit comments

Comments
 (0)