Skip to content

Commit

Permalink
pr updates
Browse files Browse the repository at this point in the history
  • Loading branch information
decleaver committed Sep 10, 2024
1 parent f0454fc commit 8595140
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/test-unit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ jobs:
- name: Install UDS CLI
uses: ./.github/actions/install-uds-cli

- name: Pull UDS Runtime binary
run: ./hack/update-uds-runtime-binaries.sh uds-runtime-linux-amd64

- name: Run unit tests
run: uds run test:unit

Expand Down
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ We strive to test all changes made to UDS CLI. If you're adding a new feature or
#### Unit Tests
Unit tests reside alongside the source code in a `*_test.go` file. These tests should be used to test individual functions or methods in isolation. Unit tests should be fast and focused on a single piece of functionality.

In order to run the unit tests in `src/cmd`, you must ensure that you have pulled the UDS Runtime binary into the `src/cmd/bin` dir. This can be done by running the `./hack/update-uds-runtime-binaries.sh` script or by running the build task for your os/architectecture (eg. `uds run build-cli-mac-apple`).

#### E2E Tests
E2E tests reside in the `src/test/e2e` directory. They use bundles located in the `src/test/e2e/bundles` which contain Zarf packages from the `src/test/e2e/packages` directory. Feel free to add new bundles and packages where appropriate. It's encouraged to write comments/metadata in any new bundles or packages to explain what they are testing.

Expand Down
2 changes: 1 addition & 1 deletion docs/command-reference/uds.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ uds COMMAND [flags]
* [uds pull](/cli/command-reference/uds_pull/) - Pull a bundle from a remote registry and save to the local file system
* [uds remove](/cli/command-reference/uds_remove/) - Remove a bundle that has been deployed already
* [uds run](/cli/command-reference/uds_run/) - Run a task using maru-runner
* [uds ui](/cli/command-reference/uds_ui/) - [beta] Deploy UDS Runtime and view UI
* [uds ui](/cli/command-reference/uds_ui/) - [beta] Launch UDS Runtime and view UI
* [uds version](/cli/command-reference/uds_version/) - Shows the version of the running UDS-CLI binary

2 changes: 1 addition & 1 deletion docs/command-reference/uds_ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ type: docs
---
## uds ui

[beta] Deploy UDS Runtime and view UI
[beta] Launch UDS Runtime and view UI

```
uds ui [flags]
Expand Down

0 comments on commit 8595140

Please sign in to comment.