Skip to content

Commit b14e49b

Browse files
committed
Add screenshots, fix typos.
Signed-off-by: Eric Promislow <[email protected]>
1 parent 1fda3b0 commit b14e49b

File tree

6 files changed

+25
-11
lines changed

6 files changed

+25
-11
lines changed

CONTRIBUTING.md

+25-11
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ creating the pull request. This can reduce rework.
1515
## Sign Your Commits
1616

1717
A sign-off is a line at the end of the explanation for a commit.
18-
All commits must to be signed. Your signature certifies that you wrote the patch
19-
or otherwise have the right to contribute the material. When you sign-off you
18+
All commits must be signed. Your signature certifies that you wrote the patch
19+
or otherwise have the right to contribute the material. When you sign off you
2020
agree to the following rules
2121
(from [developercertificate.org](https://developercertificate.org/)):
2222

@@ -104,23 +104,33 @@ clear and easy to fix (and can be avoided by running `npm t` locally before crea
104104
But when an integration, or e2e test, fails, it's sometimes useful to consult the log files
105105
for the run.
106106

107-
These can be found by first going to the github page for the PR (for an example, find an open PR at https://github.com/rancher-sandbox/rancher-desktop/pulls?q=is%3Aopen+is%3Apr),
107+
Here's how to see more details for a failed run:
108+
109+
1. The test results can be found by first going to the GitHub page for the PR (for an example, find an open PR at https://github.com/rancher-sandbox/rancher-desktop/pulls?q=is%3Aopen+is%3Apr),
108110
then look for the list of checks, find the `E2E/Integration Tests` entry, and click on the `Details` link for the first view.
109111

112+
![Failing E2E tests link](./docs/assets/images/cilogs/screenshot01.png)
113+
110114
This takes you to a more detailed view of the test, and which tests failed, but the log files are a few more clicks away.
111115

112-
First, scroll to the bottom and click on the link that reads `View more details on Cirrus CI`.
116+
2. Scroll to the bottom and click on the link that reads `View more details on Cirrus CI`.
117+
118+
![Link to Cirrus CI](./docs/assets/images/cilogs/screenshot02.png)
119+
3. Once the full test run has completed, the `Artifacts` button acts like a file-system browser.
120+
The key here is to *not* click on the download button, but to click anywhere else on the row containing the button.
113121

114-
On that page, click on the `Debug` icon near the top-right of the view.
122+
![artifacts expansion button](./docs/assets/images/cilogs/screenshot03.png)
123+
4. This opens up a file browser. Now click on the list-view icon (the left of the two icons at the right of the row).
115124

116-
Scroll to the bottom of the text view, where there should be a section labelled `Artifacts`, with the text `playwright`.
117125

118-
Clicking on the `playwright` bar should download a file called `playwright.zip` to your download directory.
119-
Unzipping it extracts a collection of nested `zip` and `tar` files corresponding to each of the `e2e` tests.
120-
You then need to crack open the tar file and you'll find the usual `*.log` files from that test's run.
126+
![list-view button](./docs/assets/images/cilogs/screenshot04.png)
127+
5. Find the `.tar` file for the failed test, and click on it to download it into your designated `downloads` directory.
121128

122-
Because each test's tar file contains the same log files, it's a good idea to extract them into a separate
123-
directory. For example, if you're working with PR 5188
129+
130+
![tar-file link](./docs/assets/images/cilogs/screenshot05.png)
131+
132+
6. Because each test's tar file contains the same log files, it's a good idea to extract them into a separate
133+
directory. For example, if you're working with PR 5188:
124134

125135
```bash
126136
Downloads$ mkdir pr5188
@@ -140,6 +150,10 @@ k3s.log lima.log server.log wsl.log
140150
At this point, ideally,
141151
the failure in the integration run will be tied to an exception in a log file related to the change in the PR.
142152

153+
Also note that due to code transpilation,
154+
the file names and line numbers in the log files will not usually correspond to the lines in the source code.
155+
You might want to add some `console.log` statements around the problematic area to highlight a problematic area.
156+
143157
## Semantic Versioning
144158

145159
Rancher Desktop follows [semantic versioning](https://semver.org/).
25.2 KB
Loading
15.7 KB
Loading
16.7 KB
Loading
11.5 KB
Loading
10 KB
Loading

0 commit comments

Comments
 (0)