Skip to content

docs: add in some notes on how to skip tests in the contributing docs #17925 #17926

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 1 commit into from
Jun 12, 2023
Merged

docs: add in some notes on how to skip tests in the contributing docs #17925 #17926

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions docs/_docs/contributing/sending-in-a-pr.md
View file
Open in desktop
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