Merge branch 'main' of https://github.com/jetify-com/devbox into feature/json-plugin-schema

Author: Bee-Mar

docs/app/docs/cli_reference/devbox_completion_zsh.md

@@ -2,8 +2,15 @@
 
 Generate the autocompletion script for the zsh shell.
 
-If shell completion is not already enabled in your environment you will need
-to enable it.  You can execute the following once:
+If you are using Oh My Zsh, just run the following:
+
+```bash
+mkdir -p ~/.oh-my-zsh/completions
+devbox completion zsh > ~/.oh-my-zsh/completions/_devbox
+```
+
+If you are not using Oh My Zsh and shell completion is not already enabled in your environment you will need
+to enable it. You can execute the following once:
 
 ```bash
 echo "autoload -U compinit; compinit" >> ~/.zshrc

docs/app/docs/configuration.md

@@ -182,11 +182,11 @@ Currently, you can only set values using string literals, `$PWD`, and `$PATH`. A
 
 ### Env From
 
-Env from takes a string or list of strings for loading environment variables into your shells and scripts. Currently it supports loading from two sources: .env files, and Jetify Secrsts.
+Env from takes a string for loading environment variables into your shells and scripts. Currently it supports loading from two sources: .env files, and Jetify Secrets.
 
 #### .env Files
 
-You can load environment variables from a `.env` file by adding the path to the file in the `env_from` field. This is useful for loading secrets or other sensitive information that you don't want to store in your `devbox.json`.
+You can load environment variables from a `.env` file by adding the path to the file in the `env_from` field (the file must end with `.env`). This is useful for loading secrets or other sensitive information that you don't want to store in your `devbox.json`.
 
 ```json
 {
@@ -198,15 +198,15 @@ This will load the environment variables from the `.env` file into your shell wh
 
 #### Jetify Secrets
 
-You can securely load secrets from Jetify Secrets by running `devbox secrets init` and creating a project in Jetify Cloud. This will add the `jetpack-cloud` field to `env_from` in your project.
+You can securely load secrets from Jetify Secrets by running `devbox secrets init` and creating a project in Jetify Cloud. This will add the `jetify-cloud` field to `env_from` in your project.
 
 ```json
 {
-    "env_from": "jetpack-cloud"
+    "env_from": "jetify-cloud"
 }
 ```
 
-Note that setting secrets securetly with Jetify Secrets requires a Jetify Cloud account. For more information, see the [Jetify Secrets](/docs/cloud/secrets/) guide.
+Note that setting secrets securely with Jetify Secrets requires a Jetify Cloud account. For more information, see the [Jetify Secrets](/docs/cloud/secrets/) guide.
 
 ### Shell
 

docs/app/docs/guides/secrets.md

@@ -28,9 +28,7 @@ For environment variables that you want to keep out of your `devbox.json` file,
 {
   "packages": {},
   "shell": {},
-  "env_from": [
-    "path/to/.env"
-  ]
+  "env_from": "path/to/.env"
 }
 ```
 

flake.lock

@@ -11,7 +11,7 @@
       let
         pkgs = nixpkgs.legacyPackages.${system};
 
-        lastTag = "0.13.5";
+        lastTag = "0.13.6";
 
         revision = if (self ? shortRev)
                    then "${self.shortRev}"

flake.nix

@@ -42,7 +42,7 @@ require (
 	github.com/zealic/go2node v0.1.0
 	go.jetify.com/typeid v1.2.0
 	go.jetpack.io/envsec v0.0.16-0.20240604163020-540ad12af899
-	go.jetpack.io/pkg v0.0.0-20240815004735-7649b4283d51
+	go.jetpack.io/pkg v0.0.0-20241025195518-152e59e26d5d
 	golang.org/x/exp v0.0.0-20240604190554-fc45aab8b7f8
 	golang.org/x/mod v0.18.0
 	golang.org/x/oauth2 v0.21.0

go.mod

@@ -17,14 +17,16 @@ import (
 	"go.jetpack.io/devbox/internal/devbox"
 	"go.jetpack.io/devbox/internal/devbox/devopt"
 	"go.jetpack.io/devbox/internal/redact"
+	"go.jetpack.io/devbox/internal/ux"
 )
 
 type runCmdFlags struct {
 	envFlag
-	config      configFlags
-	omitNixEnv  bool
-	pure        bool
-	listScripts bool
+	config       configFlags
+	omitNixEnv   bool
+	pure         bool
+	listScripts  bool
+	recomputeEnv bool
 }
 
 // runFlagDefaults are the flag default values that differ
@@ -62,6 +64,7 @@ func runCmd(defaults runFlagDefaults) *cobra.Command {
 		"shell environment will omit the env-vars from print-dev-env",
 	)
 	_ = command.Flags().MarkHidden("omit-nix-env")
+	command.Flags().BoolVar(&flags.recomputeEnv, "recompute", true, "recompute environment if needed")
 
 	command.ValidArgs = listScripts(command, flags)
 
@@ -84,6 +87,7 @@ func listScripts(cmd *cobra.Command, flags runCmdFlags) []string {
 }
 
 func runScriptCmd(cmd *cobra.Command, args []string, flags runCmdFlags) error {
+	ctx := cmd.Context()
 	if len(args) == 0 || flags.listScripts {
 		scripts := listScripts(cmd, flags)
 		if len(scripts) == 0 {
@@ -111,19 +115,32 @@ func runScriptCmd(cmd *cobra.Command, args []string, flags runCmdFlags) error {
 	// Check the directory exists.
 	box, err := devbox.Open(&devopt.Opts{
 		Dir:         path,
+		Env:         env,
 		Environment: flags.config.environment,
 		Stderr:      cmd.ErrOrStderr(),
-		Env:         env,
 	})
 	if err != nil {
 		return redact.Errorf("error reading devbox.json: %w", err)
 	}
 
 	envOpts := devopt.EnvOptions{
-		OmitNixEnv: flags.omitNixEnv,
-		Pure:       flags.pure,
+		Hooks: devopt.LifecycleHooks{
+			OnStaleState: func() {
+				if !flags.recomputeEnv {
+					ux.FHidableWarning(
+						ctx,
+						cmd.ErrOrStderr(),
+						devbox.StateOutOfDateMessage,
+						"with --recompute=true",
+					)
+				}
+			},
+		},
+		OmitNixEnv:    flags.omitNixEnv,
+		Pure:          flags.pure,
+		SkipRecompute: !flags.recomputeEnv,
 	}
-	if err := box.RunScript(cmd.Context(), envOpts, script, scriptArgs); err != nil {
+	if err := box.RunScript(ctx, envOpts, script, scriptArgs); err != nil {
 		return redact.Errorf("error running script %q in Devbox: %w", script, err)
 	}
 	return nil

go.sum

@@ -13,14 +13,16 @@ import (
 	"go.jetpack.io/devbox/internal/devbox"
 	"go.jetpack.io/devbox/internal/devbox/devopt"
 	"go.jetpack.io/devbox/internal/envir"
+	"go.jetpack.io/devbox/internal/ux"
 )
 
 type shellCmdFlags struct {
 	envFlag
-	config     configFlags
-	omitNixEnv bool
-	printEnv   bool
-	pure       bool
+	config       configFlags
+	omitNixEnv   bool
+	printEnv     bool
+	pure         bool
+	recomputeEnv bool
 }
 
 // shellFlagDefaults are the flag default values that differ
@@ -53,17 +55,20 @@ func shellCmd(defaults shellFlagDefaults) *cobra.Command {
 		"shell environment will omit the env-vars from print-dev-env",
 	)
 	_ = command.Flags().MarkHidden("omit-nix-env")
+	command.Flags().BoolVar(&flags.recomputeEnv, "recompute", true, "recompute environment if needed")
 
 	flags.config.register(command)
 	flags.envFlag.register(command)
 	return command
 }
 
 func runShellCmd(cmd *cobra.Command, flags shellCmdFlags) error {
+	ctx := cmd.Context()
 	env, err := flags.Env(flags.config.path)
 	if err != nil {
 		return err
 	}
+
 	// Check the directory exists.
 	box, err := devbox.Open(&devopt.Opts{
 		Dir:         flags.config.path,
@@ -91,9 +96,22 @@ func runShellCmd(cmd *cobra.Command, flags shellCmdFlags) error {
 		return shellInceptionErrorMsg("devbox shell")
 	}
 
-	return box.Shell(cmd.Context(), devopt.EnvOptions{
-		OmitNixEnv: flags.omitNixEnv,
-		Pure:       flags.pure,
+	return box.Shell(ctx, devopt.EnvOptions{
+		Hooks: devopt.LifecycleHooks{
+			OnStaleState: func() {
+				if !flags.recomputeEnv {
+					ux.FHidableWarning(
+						ctx,
+						cmd.ErrOrStderr(),
+						devbox.StateOutOfDateMessage,
+						"with --recompute=true",
+					)
+				}
+			},
+		},
+		OmitNixEnv:    flags.omitNixEnv,
+		Pure:          flags.pure,
+		SkipRecompute: !flags.recomputeEnv,
 	})
 }
 

internal/boxcli/run.go

@@ -116,11 +116,23 @@ func shellEnvFunc(
 	}
 
 	envStr, err := box.EnvExports(ctx, devopt.EnvExportsOpts{
-		DontRecomputeEnvironment: !flags.recomputeEnv,
 		EnvOptions: devopt.EnvOptions{
+			Hooks: devopt.LifecycleHooks{
+				OnStaleState: func() {
+					if !flags.recomputeEnv {
+						ux.FHidableWarning(
+							ctx,
+							cmd.ErrOrStderr(),
+							devbox.StateOutOfDateMessage,
+							box.RefreshAliasOrCommand(),
+						)
+					}
+				},
+			},
 			OmitNixEnv:        flags.omitNixEnv,
 			PreservePathStack: flags.preservePathStack,
 			Pure:              flags.pure,
+			SkipRecompute:     !flags.recomputeEnv,
 		},
 		NoRefreshAlias: flags.noRefreshAlias,
 		RunHooks:       flags.runInitHook,