Skip to content

docs: fixing the ReportFormat description in markdown files #2350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fixing the ReportFormat description in markdown files #2350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/configuration/options/report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Reporting options contain the configuration used by Chainsaw for reporting.

| Element | Default | Description |
|---|---|---|
| `format` | `JSON` | ReportFormat determines test report format (JSON|XML). |
| `format` | `JSON` | ReportFormat determines test report format (JSON\|XML). |
| `path` | | ReportPath defines the path. |
| `name` | `chainsaw-report` | ReportName defines the name of report to create. It defaults to "chainsaw-report". |

Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/apis/chainsaw.v1alpha1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ during the testing process.</p>
| `failFast` | `bool` | | | <p>FailFast determines whether the test should stop upon encountering the first failure.</p> |
| `parallel` | `int` | | | <p>The maximum number of tests to run at once.</p> |
| `deletionPropagationPolicy` | [`meta/v1.DeletionPropagation`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#deletionpropagation-v1-meta) | | | <p>DeletionPropagationPolicy decides if a deletion will propagate to the dependents of the object, and how the garbage collector will handle the propagation.</p> |
| `reportFormat` | [`ReportFormatType`](#chainsaw-kyverno-io-v1alpha1-ReportFormatType) | | | <p>ReportFormat determines test report format (JSON|XML|JUNIT-TEST|JUNIT-STEP|JUNIT-OPERATION|nil) nil == no report. maps to report.Type, however we don't want generated.deepcopy to have reference to it.</p> |
| `reportFormat` | [`ReportFormatType`](#chainsaw-kyverno-io-v1alpha1-ReportFormatType) | | | <p>ReportFormat determines test report format (JSON\|XML\|JUNIT-TEST\|JUNIT-STEP\|JUNIT-OPERATION\|nil) nil == no report. maps to report.Type, however we don't want generated.deepcopy to have reference to it.</p> |
| `reportPath` | `string` | | | <p>ReportPath defines the path.</p> |
| `reportName` | `string` | | | <p>ReportName defines the name of report to create. It defaults to "chainsaw-report".</p> |
| `namespace` | `string` | | | <p>Namespace defines the namespace to use for tests. If not specified, every test will execute in a random ephemeral namespace unless the namespace is overridden in a the test spec.</p> |
Expand Down
2 changes: 1 addition & 1 deletion website/docs/reference/apis/chainsaw.v1alpha2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ auto_generated: true

| Field | Type | Required | Inline | Description |
|---|---|---|---|---|
| `format` | [`ReportFormatType`](#chainsaw-kyverno-io-v1alpha2-ReportFormatType) | | | <p>ReportFormat determines test report format (JSON|XML|JUNIT-TEST|JUNIT-STEP|JUNIT-OPERATION).</p> |
| `format` | [`ReportFormatType`](#chainsaw-kyverno-io-v1alpha2-ReportFormatType) | | | <p>ReportFormat determines test report format (JSON\|XML\|JUNIT-TEST\|JUNIT-STEP\|JUNIT-OPERATION).</p> |
| `path` | `string` | | | <p>ReportPath defines the path.</p> |
| `name` | `string` | | | <p>ReportName defines the name of report to create. It defaults to "chainsaw-report".</p> |

Expand Down