From feb68378373f4e380ae15ed2196d5550bec4efc8 Mon Sep 17 00:00:00 2001 From: unclegedd Date: Wed, 10 Apr 2024 16:25:10 -0500 Subject: [PATCH 1/4] chore: refactor dev mode docs --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 088f8f95..ff39f103 100644 --- a/README.md +++ b/README.md @@ -273,6 +273,19 @@ The naming conventions for deploying duplicate packages are as follows: UDS CLI includes a vendored version of Zarf inside of its binary. To use Zarf, simply run `uds zarf `. For example, to create a Zarf package, run `uds zarf create `, or to use the [airgap tooling](https://docs.zarf.dev/docs/the-zarf-cli/cli-commands/zarf_tools) that Zarf provides, run `uds zarf tools `. ## Dev Mode -Dev mode allows you to speed up dev cycles when developing and testing bundles. `uds dev deploy` allows you to deploy a UDS bundle in dev mode. If you are missing a local zarf package, this command will create that zarf package for you assuming that your `zarf.yaml` file and zarf package are expected in the same directory. It will then create your bundle and deploy your zarf packages in [YOLO](https://docs.zarf.dev/docs/faq#what-is-yolo-mode-and-why-would-i-use-it) mode, eliminating the need to do a `zarf init` -> Note: currently dev mode only works with local bundles +> [!NOTE] +> Dev mode is a BETA feature and currently only works with local bundles + +Dev mode facilitates faster dev cycles when developing and testing bundles + +``` +uds dev deploy +``` + +The `dev deploy` command performs the following operations +- Creates Zarf packages for all local packages in a bundle + - Creates the Zarf tarball in the same directory as the `zarf.yaml` + - Will only create the Zarf tarball if one does not already exist +- Creates a bundle from the newly created Zarf packages +- Deploys the bundle in [YOLO](https://docs.zarf.dev/faq/#what-is-yolo-mode-and-why-would-i-use-it) mode, eliminating the need to do a `zarf init` From 3539a2c30ee66744d3eec38d3f63e70446682aee Mon Sep 17 00:00:00 2001 From: unclegedd Date: Wed, 10 Apr 2024 16:28:47 -0500 Subject: [PATCH 2/4] small edit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ff39f103..fe42624b 100644 --- a/README.md +++ b/README.md @@ -280,7 +280,7 @@ UDS CLI includes a vendored version of Zarf inside of its binary. To use Zarf, s Dev mode facilitates faster dev cycles when developing and testing bundles ``` -uds dev deploy +uds dev deploy ``` The `dev deploy` command performs the following operations From ea8a803db0955352718cc779ba738aebd802b2aa Mon Sep 17 00:00:00 2001 From: unclegedd Date: Wed, 10 Apr 2024 16:53:23 -0500 Subject: [PATCH 3/4] small edit --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index fe42624b..6c5cf0fa 100644 --- a/README.md +++ b/README.md @@ -287,5 +287,6 @@ The `dev deploy` command performs the following operations - Creates Zarf packages for all local packages in a bundle - Creates the Zarf tarball in the same directory as the `zarf.yaml` - Will only create the Zarf tarball if one does not already exist + - Ignores any `kind: ZarfInitConfig` packages in the bundle - Creates a bundle from the newly created Zarf packages - Deploys the bundle in [YOLO](https://docs.zarf.dev/faq/#what-is-yolo-mode-and-why-would-i-use-it) mode, eliminating the need to do a `zarf init` From 3f9fbf444e5cfc9cc69e3ee6bd166ed1812464ed Mon Sep 17 00:00:00 2001 From: unclegedd Date: Wed, 10 Apr 2024 16:54:51 -0500 Subject: [PATCH 4/4] small edit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c5cf0fa..ccf36dd4 100644 --- a/README.md +++ b/README.md @@ -280,7 +280,7 @@ UDS CLI includes a vendored version of Zarf inside of its binary. To use Zarf, s Dev mode facilitates faster dev cycles when developing and testing bundles ``` -uds dev deploy +uds dev deploy ``` The `dev deploy` command performs the following operations