wu-sheng commented on a change in pull request #62:
URL:
https://github.com/apache/skywalking-infra-e2e/pull/62#discussion_r739632698
##########
File path: docs/en/setup/Run-E2E-Tests.md
##########
@@ -31,9 +31,23 @@ e2e cleanup
To use skywalking-infra-e2e in GitHub Actions, add a step in your GitHub
workflow.
+The working directory is uploaded to GitHub Action Artifact after the task is
completed, which contains environment variables and container logs in the
environment.
+
```yaml
- name: Run E2E Test
uses: apache/skywalking-infra-e2e@main # always prefer to use a
revision instead of `main`.
with:
- e2e-file: e2e.yaml # need to run E2E file path
+ e2e-file: e2e.yaml # (required)need to run E2E file
path
+ log-dir: /path/to/log/dir # (not required)the container
logs path, if not provide it would be auto generation
Review comment:
```suggestion
log-dir: /path/to/log/dir # (Optional). Use
`<work_dir>/logs/<job_name>_<matrix_value>`(if have GHA matrix) or
`<work_dir>/logs/<job_name>` in GHA, and output logs into `xxxx` out of GHA
env, such as running locally.
```
Please fill the `xxx` and fix the sentence. Basically for the document, we
prefer the complete sentence. Grammarly tool(on Chrome) is super helpful, I
thin.
##########
File path: docs/en/setup/Run-E2E-Tests.md
##########
@@ -31,9 +31,23 @@ e2e cleanup
To use skywalking-infra-e2e in GitHub Actions, add a step in your GitHub
workflow.
+The working directory is uploaded to GitHub Action Artifact after the task is
completed, which contains environment variables and container logs in the
environment.
+
```yaml
- name: Run E2E Test
uses: apache/skywalking-infra-e2e@main # always prefer to use a
revision instead of `main`.
with:
- e2e-file: e2e.yaml # need to run E2E file path
+ e2e-file: e2e.yaml # (required)need to run E2E file
path
+ log-dir: /path/to/log/dir # (not required)the container
logs path, if not provide it would be auto generation
Review comment:
```suggestion
log-dir: /path/to/log/dir # (Optional). Use
`<work_dir>/logs/<job_name>_<matrix_value>`(if have GHA matrix) or
`<work_dir>/logs/<job_name>` in GHA, and output logs into `xxxx` out of GHA
env, such as running locally.
```
Please fill the `xxx` and fix the sentence. Basically for the document, we
prefer the complete sentence. Grammarly tool(on Chrome) is super helpful, I
think.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
