Commit6cc1e7e

committed

docs(tutorial): add pre-v2.3 GIT_SSH example

It goes along with the new one advertising the GIT_SSH_COMMANDenvironment variable.Related togitpython-developers#256

1 parent158bc98 commit6cc1e7eCopy full SHA for 6cc1e7e

File tree

-1

lines changed

-1

lines changed

Lines changed: 7 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -331,11 +331,17 @@ You can easily access configuration information for a remote by accessing option`
`331`	`331`	`:start-after: # [26-test_references_and_objects]`
`332`	`332`	`:end-before: # ![26-test_references_and_objects]`
`333`	`333`
`334`		`-You can also specify per-call custom environments using a new context manager on the Git command, e.g. for using a specific SSH key.`
	`334`	+You can also specify per-call custom environments using a new context manager on the Git command, e.g. for using a specific SSH key. The following example works with `git` starting at v2.3.
`335`	`335`
`336`	`336`	`ssh_cmd = 'ssh -i id_deployment_key'`
`337`	`337`	`with repo.git.custom_environment(GIT_SSH_COMMAND=ssh_cmd):`
`338`	`338`	`repo.remotes.origin.fetch()`
	`339`	`+`
	`340`	+This one sets a custom script to be executed in place of `ssh`, and can be used in `git` prior to v2.3.
	`341`	`+`
	`342`	`+ ssh_executable = os.path.join(rw_dir, 'my_ssh_executable.sh')`
	`343`	`+ with repo.git.custom_environment(GIT_SSH=ssh_executable):`
	`344`	`+ repo.remotes.origin.fetch()`
`339`	`345`
`340`	`346`	`Submodule Handling`
`341`	`347`	`******************`

Comments

(0)