Merge pull request #1010 from pascalbreuninger/feat/force-git-branch-…

…and-commit

feat/force git branch and commit

cmd/build.go

@@ -77,6 +77,8 @@ func NewBuildCmd(flags *flags.GlobalFlags) *cobra.Command {
 				cmd.DevContainerPath,
 				sshConfigPath,
 				nil,
+				cmd.GitBranch,
+				cmd.GitCommit,
 				false,
 				log.Default,
 			)
@@ -112,6 +114,8 @@ func NewBuildCmd(flags *flags.GlobalFlags) *cobra.Command {
 	buildCmd.Flags().StringVar(&cmd.Repository, "repository", "", "The repository to push to")
 	buildCmd.Flags().StringSliceVar(&cmd.Platform, "platform", []string{}, "Set target platform for build")
 	buildCmd.Flags().BoolVar(&cmd.SkipPush, "skip-push", false, "If true will not push the image to the repository, useful for testing")
+	buildCmd.Flags().StringVar(&cmd.GitBranch, "git-branch", "", "The git branch to use")
+	buildCmd.Flags().StringVar(&cmd.GitCommit, "git-commit", "", "The git commit SHA to use")
 
 	// TESTING
 	buildCmd.Flags().BoolVar(&cmd.ForceBuild, "force-build", false, "TESTING ONLY")

cmd/up.go

@@ -115,6 +115,8 @@ func NewUpCmd(flags *flags.GlobalFlags) *cobra.Command {
 				cmd.DevContainerPath,
 				cmd.SSHConfigPath,
 				source,
+				cmd.GitBranch,
+				cmd.GitCommit,
 				true,
 				logger,
 			)
@@ -146,6 +148,8 @@ func NewUpCmd(flags *flags.GlobalFlags) *cobra.Command {
 	upCmd.Flags().BoolVar(&cmd.OpenIDE, "open-ide", true, "If this is false and an IDE is configured, DevPod will only install the IDE server backend, but not open it")
 	upCmd.Flags().BoolVar(&cmd.ForceCredentials, "force-credentials", false, "If true will always use local credentials")
 	_ = upCmd.Flags().MarkHidden("force-credentials")
+	upCmd.Flags().StringVar(&cmd.GitBranch, "git-branch", "", "The git branch to use")
+	upCmd.Flags().StringVar(&cmd.GitCommit, "git-commit", "", "The git commit SHA to use")
 
 	upCmd.Flags().BoolVar(&cmd.DisableDaemon, "disable-daemon", false, "If enabled, will not install a daemon into the target machine to track activity")
 	upCmd.Flags().StringVar(&cmd.Source, "source", "", "Optional source for the workspace. E.g. git:https://github.com/my-org/my-repo")

desktop/src/client/constants.ts

@@ -52,5 +52,7 @@ export const DEVPOD_FLAG_DEVCONTAINER_PATH = "--devcontainer-path"
 export const DEVPOD_FLAG_WORKSPACE_ID = "--workspace-id"
 export const DEVPOD_FLAG_WORKSPACE_UID = "--workspace-uid"
 export const DEVPOD_FLAG_LOGIN = "--login"
+export const DEVPOD_FLAG_GIT_BRANCH = "--git-branch"
+export const DEVPOD_FLAG_GIT_COMMIT = "--git-commit"
 
 export const DEVPOD_UI_ENV_VAR = "DEVPOD_UI"

desktop/src/client/workspaces/workspaceCommands.ts

@@ -19,6 +19,8 @@ import {
   DEVPOD_FLAG_DEBUG,
   DEVPOD_FLAG_DEVCONTAINER_PATH,
   DEVPOD_FLAG_FORCE,
+  DEVPOD_FLAG_GIT_BRANCH,
+  DEVPOD_FLAG_GIT_COMMIT,
   DEVPOD_FLAG_ID,
   DEVPOD_FLAG_IDE,
   DEVPOD_FLAG_JSON_LOG_OUTPUT,
@@ -121,6 +123,16 @@ export class WorkspaceCommands {
         ? toMultipleFlagArg(WorkspaceCommands.ADDITIONAL_FLAGS)
         : []
 
+    const maybeGitBranch = config.sourceConfig?.gitBranch
+    const gitBranchFlag = exists(maybeGitBranch)
+      ? [toFlagArg(DEVPOD_FLAG_GIT_BRANCH, maybeGitBranch)]
+      : []
+
+    const maybeGitCommit = config.sourceConfig?.gitCommit
+    const gitCommitFlag = exists(maybeGitCommit)
+      ? [toFlagArg(DEVPOD_FLAG_GIT_COMMIT, maybeGitCommit)]
+      : []
+
     return WorkspaceCommands.newCommand([
       DEVPOD_COMMAND_UP,
       identifier,
@@ -129,6 +141,8 @@ export class WorkspaceCommands {
       ...maybeProviderFlag,
       ...maybePrebuildRepositories,
       ...maybeDevcontainerPath,
+      ...gitBranchFlag,
+      ...gitCommitFlag,
       ...additionalFlags,
       DEVPOD_FLAG_JSON_LOG_OUTPUT,
     ])

desktop/src/types.ts

@@ -162,6 +162,8 @@ export type TWorkspaceStartConfig = Readonly<{
   // Instead of starting a workspace just by ID, the sourceConfig starts it with a `source/ID` combination
   sourceConfig?: Readonly<{
     source: string
+    gitBranch: string | undefined
+    gitCommit: string | undefined
   }>
 }>
 export const SUPPORTED_IDES = ["vscode", "intellj"] as const

desktop/src/views/Workspaces/CreateWorkspace/CreateWorkspace.tsx

@@ -1,4 +1,4 @@
-import { ExampleCard, Form, IDEIcon, WarningMessageBox } from "@/components"
+import { CollapsibleSection, ExampleCard, Form, IDEIcon, WarningMessageBox } from "@/components"
 import {
   Box,
   Button,
@@ -71,6 +71,8 @@ export function CreateWorkspace() {
       defaultIDE,
       workspaceSource,
       devcontainerPath,
+      gitBranch,
+      gitCommit,
     }: TCreateWorkspaceArgs) => {
       const actionID = workspace.create({
         id: workspaceID,
@@ -80,6 +82,8 @@ export function CreateWorkspace() {
         ideConfig: { name: defaultIDE },
         sourceConfig: {
           source: workspaceSource,
+          gitBranch,
+          gitCommit,
         },
       })
 
@@ -109,6 +113,8 @@ export function CreateWorkspace() {
     idError,
     prebuildRepositoryError,
     devcontainerPathError,
+    gitBranchError,
+    gitCommitError,
   } = useFormErrors(Object.values(FieldName), formState)
 
   const providerOptions = useMemo<TSelectProviderOptions>(() => {
@@ -436,6 +442,43 @@ export function CreateWorkspace() {
               {/* placholder box */}
               <Box width={"full"} />
             </HStack>
+
+            <CollapsibleSection title="Git Options" showIcon>
+              <HStack spacing="8" alignItems={"top"} width={"100%"} justifyContent={"start"}>
+                <FormControl isInvalid={exists(gitBranchError)}>
+                  <FormLabel>Git Branch</FormLabel>
+                  <Input
+                    spellCheck={false}
+                    placeholder="main"
+                    type="text"
+                    {...register(FieldName.GIT_BRANCH)}
+                  />
+                  {exists(gitBranchError) ? (
+                    <FormErrorMessage>{gitBranchError.message ?? "Error"}</FormErrorMessage>
+                  ) : (
+                    <FormHelperText>
+                      Optionally specify the branch name for this workspace.
+                    </FormHelperText>
+                  )}
+                </FormControl>
+                <FormControl isInvalid={exists(gitCommitError)}>
+                  <FormLabel>Git Commit</FormLabel>
+                  <Input
+                    spellCheck={false}
+                    placeholder="SHA256"
+                    type="text"
+                    {...register(FieldName.GIT_COMMIT)}
+                  />
+                  {exists(gitCommitError) ? (
+                    <FormErrorMessage>{gitCommitError.message ?? "Error"}</FormErrorMessage>
+                  ) : (
+                    <FormHelperText>
+                      Optionally specify the commit SHA256 for this workspace.
+                    </FormHelperText>
+                  )}
+                </FormControl>
+              </HStack>
+            </CollapsibleSection>
           </VStack>
 
           <HStack

desktop/src/views/Workspaces/CreateWorkspace/types.ts

@@ -9,6 +9,8 @@ export const FieldName = {
   PROVIDER: "provider",
   PREBUILD_REPOSITORY: "prebuildRepository",
   DEVCONTAINER_PATH: "devcontainerPath",
+  GIT_BRANCH: "gitBranch",
+  GIT_COMMIT: "gitCommit",
 } as const
 
 export type TFormValues = {
@@ -18,6 +20,8 @@ export type TFormValues = {
   [FieldName.ID]: string
   [FieldName.PREBUILD_REPOSITORY]: string
   [FieldName.DEVCONTAINER_PATH]?: string
+  [FieldName.GIT_BRANCH]?: string
+  [FieldName.GIT_COMMIT]?: string
 }
 
 export type TCreateWorkspaceSearchParams = ReturnType<
@@ -30,6 +34,8 @@ export type TCreateWorkspaceArgs = Readonly<{
   defaultIDE: string
   workspaceSource: string
   devcontainerPath: string | undefined
+  gitBranch: string | undefined
+  gitCommit: string | undefined
 }>
 export type TSelectProviderOptions = Readonly<{
   installed: readonly TNamedProvider[]

desktop/src/views/Workspaces/CreateWorkspace/useCreateWorkspaceForm.tsx

@@ -221,6 +221,8 @@ export function useCreateWorkspaceForm(
         const prebuildRepositories = data[FieldName.PREBUILD_REPOSITORY]
           ? [data[FieldName.PREBUILD_REPOSITORY]]
           : []
+        const gitBranch = data[FieldName.GIT_BRANCH]
+        const gitCommit = data[FieldName.GIT_COMMIT]
 
         onCreateWorkspace({
           workspaceID,
@@ -229,6 +231,8 @@ export function useCreateWorkspaceForm(
           defaultIDE,
           workspaceSource,
           devcontainerPath: maybeDevcontainerPath,
+          gitBranch,
+          gitCommit,
         })
       })(event),
     [

pkg/provider/workspace.go

@@ -179,6 +179,8 @@ type CLIOptions struct {
 	DisableDaemon        bool     `json:"disableDaemon,omitempty"`
 	DaemonInterval       string   `json:"daemonInterval,omitempty"`
 	ForceCredentials     bool     `json:"forceCredentials,omitempty"`
+	GitBranch            string   `json:"gitBranch,omitempty"`
+	GitCommit            string   `json:"gitCommit,omitempty"`
 
 	// build options
 	Repository string   `json:"repository,omitempty"`

pkg/workspace/workspace.go

@@ -163,6 +163,7 @@ func ResolveWorkspace(
 	devContainerPath string,
 	sshConfigPath string,
 	source *provider2.WorkspaceSource,
+	gitBranch, gitCommit string,
 	changeLastUsed bool,
 	log log.Logger,
 ) (client.BaseWorkspaceClient, error) {
@@ -176,7 +177,20 @@ func ResolveWorkspace(
 	}
 
 	// resolve workspace
-	provider, workspace, machine, err := resolveWorkspace(ctx, devPodConfig, args, desiredID, desiredMachine, providerUserOptions, sshConfigPath, source, changeLastUsed, log)
+	provider, workspace, machine, err := resolveWorkspace(
+		ctx,
+		devPodConfig,
+		args,
+		desiredID,
+		desiredMachine,
+		providerUserOptions,
+		sshConfigPath,
+		source,
+		gitBranch,
+		gitCommit,
+		changeLastUsed,
+		log,
+	)
 	if err != nil {
 		return nil, err
 	}
@@ -247,6 +261,7 @@ func resolveWorkspace(
 	providerUserOptions []string,
 	sshConfigPath string,
 	source *provider2.WorkspaceSource,
+	gitBranch, gitCommit string,
 	changeLastUsed bool,
 	log log.Logger,
 ) (*provider2.ProviderConfig, *provider2.Workspace, *provider2.Machine, error) {
@@ -280,7 +295,20 @@ func resolveWorkspace(
 	}
 
 	// create workspace
-	provider, workspace, machine, err := createWorkspace(ctx, devPodConfig, workspaceID, name, desiredMachine, providerUserOptions, sshConfigPath, source, isLocalPath, log)
+	provider, workspace, machine, err := createWorkspace(
+		ctx,
+		devPodConfig,
+		workspaceID,
+		name,
+		desiredMachine,
+		providerUserOptions,
+		sshConfigPath,
+		source,
+		isLocalPath,
+		gitBranch,
+		gitCommit,
+		log,
+	)
 	if err != nil {
 		_ = clientimplementation.DeleteWorkspaceFolder(devPodConfig.DefaultContext, workspaceID, sshConfigPath, log)
 		return nil, nil, nil, err
@@ -299,6 +327,7 @@ func createWorkspace(
 	sshConfigPath string,
 	source *provider2.WorkspaceSource,
 	isLocalPath bool,
+	gitBranch, gitCommit string,
 	log log.Logger,
 ) (*provider2.ProviderConfig, *provider2.Workspace, *provider2.Machine, error) {
 	// get default provider
@@ -316,7 +345,7 @@ func createWorkspace(
 	}
 
 	// resolve workspace
-	workspace, err := resolve(provider, devPodConfig, name, workspaceID, workspaceFolder, source, isLocalPath, sshConfigPath)
+	workspace, err := resolve(provider, devPodConfig, name, workspaceID, workspaceFolder, source, isLocalPath, sshConfigPath, gitBranch, gitCommit)
 	if err != nil {
 		return nil, nil, nil, err
 	}
@@ -420,6 +449,7 @@ func resolve(
 	source *provider2.WorkspaceSource,
 	isLocalPath bool,
 	sshConfigPath string,
+	fallbackGitBranch, fallbackGitCommit string,
 ) (*provider2.Workspace, error) {
 	now := types.Now()
 	uid := encoding.CreateNewUID(devPodConfig.DefaultContext, workspaceID)
@@ -460,6 +490,12 @@ func resolve(
 			GitCommit:      gitCommit,
 			GitSubPath:     gitSubdir,
 		}
+		if workspace.Source.GitCommit == "" && fallbackGitCommit != "" {
+			workspace.Source.GitCommit = fallbackGitCommit
+		}
+		if workspace.Source.GitBranch == "" && fallbackGitBranch != "" {
+			workspace.Source.GitBranch = fallbackGitBranch
+		}
 		return workspace, nil
 	}
 
@@ -480,9 +516,15 @@ func resolve(
 	if gitPRReference != "" {
 		workspace.Source.GitPRReference = gitPRReference
 	}
+	if fallbackGitBranch != "" {
+		workspace.Source.GitBranch = fallbackGitBranch
+	}
 	if gitBranch != "" {
 		workspace.Source.GitBranch = gitBranch
 	}
+	if fallbackGitCommit != "" {
+		workspace.Source.GitCommit = fallbackGitCommit
+	}
 	if gitCommit != "" {
 		workspace.Source.GitCommit = gitCommit
 	}