Skip to content

Commit bae5e9b

Browse files
author
Vaughn Dice
committed
docs(submitting-a-pull-request.md): update instructions
to list PR number as opposed to commit sha value Ref TBD
1 parent 2ea59b3 commit bae5e9b

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,23 @@ Changes to any Deis Workflow component that could affect a user's experience als
2828

2929
## Cross-repo commits
3030

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.
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 (derived from PR issue number supplied) to the test runner so it can source the necessary Docker images for inclusion in the generated Workflow chart to be tested.
3232

3333
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:
3434

3535
```
3636
feat(foo_test): add e2e test for feature foo
3737
38-
[skip e2e] test for controller PR #42
38+
[skip e2e] test for controller#42
3939
```
4040
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.
4141

42-
Lastly, the final PR in `deis/controller` should be created with the required commits listed, for use by the downstream e2e run.
42+
Lastly, the final PR in `deis/controller` should be created with the required PR number(s) listed, in the form of `[Rr]equires <repoName>#<pullRequestNumber>`, for use by the downstream e2e run.
4343

4444
```
4545
feat(foo): add feature foo
4646
47-
Requires workflow-e2e#abc1234
47+
Requires workflow-e2e#42
4848
```
4949

5050
## Code Standards

0 commit comments

Comments
 (0)