Skip to content

Commit 85b3a6d

Browse files
committed
Document pr_skip marker in CONTRIBUTING.md
1 parent 32f9398 commit 85b3a6d

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,20 @@ def test_tier1_my_feature_in_container(self):
123123

124124
4. Each runtime should have one non-container and one container tier 1 test.
125125

126+
### Skipping tests in PR workflow (`pr_skip`)
127+
128+
Tests marked with `@pytest.mark.pr_skip` are excluded from the PR workflow (`.github/workflows/build.yml`) but still run in the integration workflow (`.github/workflows/integration-tests.yml`). Use this marker for tests that are redundant with other tests in the same file or low-risk for PR validation.
129+
130+
```python
131+
@pytest.mark.pr_skip
132+
class TestMyRedundantFeature(TestBase):
133+
...
134+
```
135+
136+
The marker is registered in `pytest.ini`. PR workflow jobs filter with `-m "not pr_skip"`.
137+
138+
Before adding `pr_skip`, verify the test is covered by at least one job in `integration-tests.yml`.
139+
126140

127141
## Finding contributions to work on
128142
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-sam-cli/labels/help%20wanted) issues is a great place to start.

0 commit comments

Comments
 (0)