Skip to content

Commit 902318a

Browse files
author
Vincent (Wen Yu) Ge
authored
Update README.md (#85)
* Update README.md * Address comments * Update README.md * Update README.md * trunk fmt
1 parent d7b84e2 commit 902318a

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
uses: trunk-io/analytics-uploader@main
3232
with:
3333
# Path to your test results.
34-
junit-paths: target/path/**/*_test.xml
34+
junit-paths: "target/path/**/*_test.xml"
3535
# Provide your Trunk organization url slug.
3636
# To find your org slug, log into app.trunk.io and you should be redirected to a URL like:
3737
# https://app.trunk.io/my-trunk-org-slug/repo-owner/repo-name/ci-analytics
@@ -43,18 +43,33 @@ jobs:
4343
continue-on-error: true
4444
```
4545
46-
### Inputs
47-
48-
| Parameter | Description |
49-
| ------------------ | ------------------------------------------------------------------------ |
50-
| `junit-paths` | **Required.** Comma-separated list of glob paths to junit files. |
51-
| `org-slug` | **Required.** Organization slug. |
52-
| `token` | **Optional.** Organization token. Defaults to `TRUNK_API_TOKEN` env var. |
53-
| `repo-head-branch` | **Optional.** Branch of repository head. |
54-
| `repo-root` | **Optional.** Root directory of the repository. |
55-
| `team` | **Optional.** Team that owns the upload. |
56-
| `run` | **Optional.** Command to run before uploading test results. |
57-
| `cli-version` | **Optional.** Version of the uploader to use. |
46+
## Arguments
47+
48+
### Input Sources (At least one required)
49+
50+
| Parameter | Description |
51+
| ---------------- | ------------------------------------------------------- |
52+
| `junit-paths` | Comma-separated list of glob paths to junit files. |
53+
| `xcresult-path` | Path to the xcresult directory. |
54+
| `bazel-bep-path` | Path to the bazel BEP file to parse in place of junits. |
55+
56+
### Required Parameters
57+
58+
| Parameter | Description |
59+
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
60+
| `org-slug` | Organization slug. |
61+
| `token` | Organization token. Must be explicitly passed in or defined as an environment variable named `TRUNK_API_TOKEN`. Defaults to the `TRUNK_API_TOKEN` when left empty. |
62+
63+
### Optional Parameters
64+
65+
| Parameter | Description | Default |
66+
| --------------------------- | --------------------------------------------------------------------- | -------- |
67+
| `repo-head-branch` | Value to override branch of repository head. | |
68+
| `repo-root` | The root directory of the repository. | |
69+
| `run` | The command to run before uploading test results. | |
70+
| `cli-version` | The version of the uploader to use. | `latest` |
71+
| `quarantine` | Whether or not to allow quarantining of failing tests. | |
72+
| `allow-missing-junit-files` | Whether or not to allow missing junit files in the upload invocation. | `true` |
5873

5974
## Questions
6075

0 commit comments

Comments
 (0)