Skip to content

Commit

Permalink
docs: add in some notes on how to skip tests in the contributing docs #…
Browse files Browse the repository at this point in the history
…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">
  • Loading branch information
ckipp01 committed Jun 12, 2023
1 parent e9fc641 commit 9a58aa2
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/_docs/contributing/sending-in-a-pr.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,23 @@ Here is the body of your pr with some more information
Closes #2
```

#### Skipping parts of CI

Depending on what your PR is addressing, sometimes it doesn't make sense to run
every part of CI. For example, maybe you're just updating some documentation and
there is no need to run the community build for this. We skip parts of the CI by
utilizing keywords inside of brackets. The most up-to-date way to see this are
by looking in the `if` statements of jobs. For example you can see some
[here](https://github.com/lampepfl/dotty/blob/5d2812a5937389f8a46f9e97ab9cbfbb3f298d87/.github/workflows/ci.yaml#L54-L64).
Below are commonly used ones:


|---------------------------|---------------------------------|
| `[skip ci]` | Skip the entire CI |
| `[skip community_build]` | Skip the entire community build |
| `[skip community_build_a]`| Skip the "a" community build |
| `[skip docs]` | Skip the scaladoc tests |

### 7: Create your PR!

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

0 comments on commit 9a58aa2

Please sign in to comment.