Skip to content

Commit b99a874

Browse files
ckipp01Kordyjan
authored andcommitted
docs: add in some notes on how to skip tests in the contributing docs #17925 (#17926)
[skip test] [skip community_build] [skip test_sbt] [skip test_windows_fast] [skip mima] Rendered it looks like this: <img width="1110" alt="Screenshot 2023-06-06 at 16 15 53" src="https://github.com/lampepfl/dotty/assets/13974112/4b9542a7-cbe2-4068-bfe6-c28418747a94"> [Cherry-picked 9a58aa2]
1 parent 1f95fea commit b99a874

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/_docs/contributing/sending-in-a-pr.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,23 @@ Here is the body of your pr with some more information
9797
Closes #2
9898
```
9999

100+
#### Skipping parts of CI
101+
102+
Depending on what your PR is addressing, sometimes it doesn't make sense to run
103+
every part of CI. For example, maybe you're just updating some documentation and
104+
there is no need to run the community build for this. We skip parts of the CI by
105+
utilizing keywords inside of brackets. The most up-to-date way to see this are
106+
by looking in the `if` statements of jobs. For example you can see some
107+
[here](https://github.com/lampepfl/dotty/blob/5d2812a5937389f8a46f9e97ab9cbfbb3f298d87/.github/workflows/ci.yaml#L54-L64).
108+
Below are commonly used ones:
109+
110+
111+
|---------------------------|---------------------------------|
112+
| `[skip ci]` | Skip the entire CI |
113+
| `[skip community_build]` | Skip the entire community build |
114+
| `[skip community_build_a]`| Skip the "a" community build |
115+
| `[skip docs]` | Skip the scaladoc tests |
116+
100117
### 7: Create your PR!
101118

102119
When the feature or fix is completed you should open a [Pull

0 commit comments

Comments
 (0)