feat(core): add --force flag to dev command

This flag force-deploys services when the command starts (but after that, doesn't force-deploy them on source changes).
garden-io · Oct 25, 2021 · 4312152 · 4312152
1 parent edd5e3f
commit 4312152
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/core/src/commands/dev.ts b/core/src/commands/dev.ts
@@ -41,6 +41,7 @@ const devArgs = {
 }
 
 const devOpts = {
+  "force": new BooleanParameter({ help: "Force redeploy of service(s)." }),
   "hot-reload": new StringsParameter({
     help: deline`The name(s) of the service(s) to deploy with hot reloading enabled.
       Use comma as a separator to specify multiple services. Use * to deploy all
@@ -85,6 +86,7 @@ export class DevCommand extends Command<DevCommandArgs, DevCommandOpts> {
         garden dev --hot=foo-service,bar-service  # enable hot reloading for foo-service and bar-service
         garden dev --hot=*                        # enable hot reloading for all compatible services
         garden dev --skip-tests=                  # skip running any tests
+        garden dev --force                        # force redeploy of services when the command starts
         garden dev --name integ                   # run all tests with the name 'integ' in the project
         garden test --name integ*                 # run all tests with the name starting with 'integ' in the project
   `
@@ -165,6 +167,7 @@ export class DevCommand extends Command<DevCommandArgs, DevCommandOpts> {
       devModeServiceNames,
       hotReloadServiceNames,
       skipTests,
+      forceDeploy: opts.force,
     })
 
     const results = await processModules({
@@ -204,6 +207,7 @@ export async function getDevCommandInitialTasks({
   devModeServiceNames,
   hotReloadServiceNames,
   skipTests,
+  forceDeploy,
 }: {
   garden: Garden
   log: LogEntry
@@ -213,6 +217,7 @@ export async function getDevCommandInitialTasks({
   devModeServiceNames: string[]
   hotReloadServiceNames: string[]
   skipTests: boolean
+  forceDeploy: boolean
 }) {
   const moduleTasks = flatten(
     await Bluebird.map(modules, async (module) => {
@@ -235,7 +240,7 @@ export async function getDevCommandInitialTasks({
             module,
             devModeServiceNames,
             hotReloadServiceNames,
-            force: false,
+            force: forceDeploy,
             forceBuild: false,
           })
 

diff --git a/docs/reference/commands.md b/docs/reference/commands.md
@@ -897,6 +897,7 @@ Examples:
     garden dev --hot=foo-service,bar-service  # enable hot reloading for foo-service and bar-service
     garden dev --hot=*                        # enable hot reloading for all compatible services
     garden dev --skip-tests=                  # skip running any tests
+    garden dev --force                        # force redeploy of services when the command starts
     garden dev --name integ                   # run all tests with the name 'integ' in the project
     garden test --name integ*                 # run all tests with the name starting with 'integ' in the project
 
@@ -918,6 +919,7 @@ Examples:
 
 | Argument | Alias | Type | Description |
 | -------- | ----- | ---- | ----------- |
+  | `--force` |  | boolean | Force redeploy of service(s).
   | `--hot-reload` | `-hot` | array:string | The name(s) of the service(s) to deploy with hot reloading enabled. Use comma as a separator to specify multiple services. Use * to deploy all services with hot reloading enabled (ignores services belonging to modules that don&#x27;t support or haven&#x27;t configured hot reloading).
   | `--skip-tests` |  | boolean | Disable running the tests.
   | `--test-names` | `-tn` | array:string | Filter the tests to run by test name across all modules (leave unset to run all tests). Accepts glob patterns (e.g. integ* would run both &#x27;integ&#x27; and &#x27;integration&#x27;).