Skip to content

Commit 2286765

Browse files
author
Vaughn Dice
committed
docs(submitting-a-pull-request.md): add info on testing paired commits
Ref deis/jenkins-jobs#104
1 parent a0850fd commit 2286765

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

src/contributing/submitting-a-pull-request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,26 @@ See [testing](testing.md) for more information.
2626

2727
Changes to any Deis Workflow component that could affect a user's experience also require a change or addition to the relevant documentation. For most Deis components, this involves updating the component's _own_ documentation. In some cases where a component is tightly integrated into [deis/workflow][workflow], its documentation must also be updated.
2828

29+
## Cross-repo commits
30+
31+
If a pull request is part of a larger piece of work involving one or more additional commits in other Workflow repositories, these commits can be referenced in the last PR to be submitted. The downstream [e2e test job](https://ci.deis.io/job/workflow-test-pr/) will then supply every referenced commit to the test runner so it can source the necessary Docker images for inclusion in the generated Workflow chart to be tested.
32+
33+
For example, consider paired commits in [deis/controller](https://github.com/deis/controller) and [deis/workflow-e2e](https://github.com/deis/workflow-e2e). The commit body for the first PR in `deis/workflow-e2e` would look like:
34+
35+
```
36+
feat(foo_test): add e2e test for feature foo
37+
38+
[skip e2e] test for controller PR #42
39+
```
40+
Adding `[skip e2e]` forgoes the e2e tests on this commit. This and any other required PRs aside from the final PR should be submitted first, so that their respective build and image push jobs run.
41+
42+
Lastly, the final PR in `deis/controller` should be created with the required commits listed, for use by the downstream e2e run.
43+
44+
```
45+
feat(foo): add feature foo
46+
47+
Requires workflow-e2e#abc1234
48+
```
2949

3050
## Code Standards
3151

0 commit comments

Comments
 (0)