Skip to content

Commit 19fddb5

Browse files
committed
docs: add in some notes on how to skip tests in the contributing docs
[skip test] [skip community_build] [skip test_sbt] [skip test_windows_fast]
1 parent 0749271 commit 19fddb5

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,25 @@ 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+
117+
118+
100119
### 7: Create your PR!
101120

102121
When the feature or fix is completed you should open a [Pull
@@ -109,7 +128,7 @@ of your pr title to make this extra clear.
109128

110129
Shortly after creating your pull request a maintainer should assign someone to
111130
review it. If this doesn't happen after a few days, feel free to ping someone on
112-
the [Scala Contributors Discor][discord] or tag someone on the PR. Depending on
131+
the [Scala Contributors Discord][discord] or tag someone on the PR. Depending on
113132
the type of pull request there might be multiple people that take a look at your
114133
changes. There might also be community input as we try to keep the review
115134
process as open as possible.

0 commit comments

Comments
 (0)