Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion client_reference/kosli_allow_artifact.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ is set), registry credentials are resolved as follows:
for public images
`--registry-provider` is deprecated and no longer used.


To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

## Flags
| Flag | Type | Description |
Expand Down
6 changes: 5 additions & 1 deletion client_reference/kosli_assert_artifact.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ to a specific flow. Without `--flow`, all flows containing the artifact
Exits with zero code if the artifact has compliant status,
non-zero code if non-compliant status.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

## Flags
| Flag | Type | Description |
| :--- | :--- | :--- |
Expand Down Expand Up @@ -69,7 +73,7 @@ non-zero code if non-compliant status.
<Tab title="GitHub">
View an example of the `kosli assert artifact` command in GitHub.

In [this YAML file](https://github.com/cyber-dojo/differ/blob/a88b337310cef9b1ee259d18db3d43fed5dd9e03/.github/workflows/main.yml#L271)
In [this YAML file](https://github.com/cyber-dojo/differ/blob/dbf0c0f13b6df5bc50b4616cc0f7c1c22bb91e24/.github/workflows/main.yml#L271)
</Tab>
<Tab title="GitLab">
View an example of the `kosli assert artifact` command in GitLab.
Expand Down
4 changes: 4 additions & 0 deletions client_reference/kosli_attest_custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ The attestation can be bound to an *artifact* in two ways:
- using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).
- using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

You can optionally associate the attestation to a git commit using `--commit` (requires access to a git repo).
You can optionally redact some of the git commit data sent to Kosli using `--redact-commit-info`.
Note that when the attestation is reported for an artifact that does not yet exist in Kosli, `--commit` is required to facilitate
Expand Down
4 changes: 4 additions & 0 deletions client_reference/kosli_attest_decision.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ The attestation can be bound to an *artifact* in two ways:
- using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).
- using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

You can optionally associate the attestation to a git commit using `--commit` (requires access to a git repo).
You can optionally redact some of the git commit data sent to Kosli using `--redact-commit-info`.
Note that when the attestation is reported for an artifact that does not yet exist in Kosli, `--commit` is required to facilitate
Expand Down
4 changes: 4 additions & 0 deletions client_reference/kosli_attest_generic.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ The attestation can be bound to an *artifact* in two ways:
- using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).
- using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

You can optionally associate the attestation to a git commit using `--commit` (requires access to a git repo).
You can optionally redact some of the git commit data sent to Kosli using `--redact-commit-info`.
Note that when the attestation is reported for an artifact that does not yet exist in Kosli, `--commit` is required to facilitate
Expand Down
10 changes: 8 additions & 2 deletions client_reference/kosli_attest_jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ The found issue references will be checked against Jira to confirm their existen
The attestation is reported in all cases, and its compliance status depends on referencing
existing Jira issues.
If you have wrong Jira credentials or wrong Jira-base-url it will be reported as non existing Jira issue.
This is because Jira returns same 404 error code in all cases.
This is because Jira returns same 404 error code in all cases. When Jira's response shows that it did not

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improvement — the new sentence contradicts the one before it.

Line 45 still says wrong credentials or a wrong base URL "will be reported as non existing Jira issue". The new text on 46–48 says the opposite for the credentials case: the issue is "reported as not confirmed rather than silently as missing". A reader hitting a credential failure gets two different answers about what Kosli reports.

Also, "a warning naming them is printed" is ambiguous — them reads back to "the credentials", but naming which credentials? (the username? the flag that supplied them?) Spelling out what the warning identifies would make this actionable.

Suggest reworking the paragraph upstream as a single statement, roughly: a wrong base URL still surfaces as a non-existent issue because Jira returns 404 either way, but a credential rejection is detected and reported as not confirmed, with a warning identifying the credentials — use --debug to see the status Jira returned per issue.

accept the credentials, a warning naming them is printed and the issue is reported as not confirmed rather
than silently as missing; run with `--debug` to see the status Jira returned for each issue.

The `--jira-issue-fields` can be used to include fields from the jira issue. By default no fields
are included. `*all` will give all fields. Using `--jira-issue-fields "*all" --dry-run` will give you
Expand All @@ -56,6 +58,10 @@ The attestation can be bound to an *artifact* in two ways:
- using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).
- using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

You can optionally associate the attestation to a git commit using `--commit` (requires access to a git repo).
You can optionally redact some of the git commit data sent to Kosli using `--redact-commit-info`.
Note that when the attestation is reported for an artifact that does not yet exist in Kosli, `--commit` is required to facilitate
Expand Down Expand Up @@ -85,7 +91,7 @@ In other CI systems, set them explicitly to capture repository metadata.
| `--jira-base-url` | string | The base url for the jira project, e.g. `https://kosli.atlassian.net` |
| `--jira-issue-fields` | string | [optional] The comma separated list of fields to include from the Jira issue. Default no fields are included. '*all' will give all fields. |
| `--jira-pat` | string | Jira personal access token (for self-hosted Jira) |
| `--jira-project-key` | strings | [optional] Jira project key to match against. Can be repeated. Defaults to matching any jira project key. |
| `--jira-project-key` | strings | [optional] Jira project key to match against. Can be repeated, or given as a comma-separated list. Defaults to matching any jira project key. |
| `--jira-secondary-source` | string | [optional] An optional string to search for Jira ticket reference, e.g. '`--jira-secondary-source` $\{\{ github.head_ref \}\}' |
| `--jira-username` | string | Jira username (for Jira Cloud) |
| `-n`, `--name` | string | The name of the attestation as declared in the flow or trail yaml template. |
Expand Down
4 changes: 4 additions & 0 deletions client_reference/kosli_attest_junit.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ The attestation can be bound to an *artifact* in two ways:
- using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).
- using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

You can optionally associate the attestation to a git commit using `--commit` (requires access to a git repo).
You can optionally redact some of the git commit data sent to Kosli using `--redact-commit-info`.
Note that when the attestation is reported for an artifact that does not yet exist in Kosli, `--commit` is required to facilitate
Expand Down
4 changes: 4 additions & 0 deletions client_reference/kosli_attest_pullrequest_azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ The attestation can be bound to an *artifact* in two ways:
- using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).
- using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

## Flags
| Flag | Type | Description |
| :--- | :--- | :--- |
Expand Down
4 changes: 4 additions & 0 deletions client_reference/kosli_attest_pullrequest_bitbucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ The attestation can be bound to an *artifact* in two ways:
- using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).
- using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

## Flags
| Flag | Type | Description |
| :--- | :--- | :--- |
Expand Down
4 changes: 4 additions & 0 deletions client_reference/kosli_attest_pullrequest_github.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ The attestation can be bound to an *artifact* in two ways:
- using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).
- using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

## Flags
| Flag | Type | Description |
| :--- | :--- | :--- |
Expand Down
4 changes: 4 additions & 0 deletions client_reference/kosli_attest_pullrequest_gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ The attestation can be bound to an *artifact* in two ways:
- using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).
- using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

## Flags
| Flag | Type | Description |
| :--- | :--- | :--- |
Expand Down
4 changes: 4 additions & 0 deletions client_reference/kosli_attest_snyk.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ The attestation can be bound to an *artifact* in two ways:
- using the artifact's SHA256 fingerprint which is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).
- using the artifact's name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact.
Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`.
The `.kosli_ignore` will be treated as part of the artifact like any other file, unless it is explicitly ignored itself.

You can optionally associate the attestation to a git commit using `--commit` (requires access to a git repo).
You can optionally redact some of the git commit data sent to Kosli using `--redact-commit-info`.
Note that when the attestation is reported for an artifact that does not yet exist in Kosli, `--commit` is required to facilitate
Expand Down
Loading