Skip to content
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.

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

Document the new galasactl runs delete command #826

Merged
merged 1 commit into from
Sep 18, 2024
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
2 changes: 2 additions & 0 deletions src/data/nav.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@
path: /docs/manage-ecosystem/cli-runs-get
- title: Downloading test artifacts
path: /docs/manage-ecosystem/ecosystem-cli-runs-download
- title: Deleting test run results
path: /docs/manage-ecosystem/cli-runs-delete
- title: Upgrading
path: /docs/upgrading
- title: Managers
Expand Down
28 changes: 28 additions & 0 deletions src/markdown-pages/docs/manage-ecosystem/runs-delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
path: "/docs/manage-ecosystem/cli-runs-delete"
title: "Deleting test run results"
---

Over time, test run results build up and take up space in the Galasa Ecosystem. You can delete test runs which have completed in the past by using the `galasactl runs delete` command.

You can view the full command syntax in the <a href="https://github.com/galasa-dev/cli/blob/main/docs/generated/galasactl_runs_delete.md" target="_blank">Galasa cli repository</a>.

## Working with the `galasactl runs delete` command

The following example deletes a test run called _C1234_:

```
galasactl runs delete --name C1234 --bootstrap http://example.com:30960/bootstrap
```

## Identifying test runs to delete

Use the `galasactl runs get` command to find the names of the test runs to delete. For example, use the `--age` option to specify a time period in which the tests ran.

```
galasactl runs get --age 6w:1w --bootstrap http://example.com:30960/bootstrap
```

The `--format raw` option is useful if you are writing a script to delete multiple test runs.

You can view the full command syntax for `galasactl runs get` in the <a href="https://github.com/galasa-dev/cli/blob/main/docs/generated/galasactl_runs_get.md" target="_blank">Galasa cli repository</a>.
Loading