/ src / git-source-settings.ts
git-source-settings.ts
 1  export interface IGitSourceSettings {
 2    /**
 3     * The location on disk where the repository will be placed
 4     */
 5    repositoryPath: string
 6  
 7    /**
 8     * The repository owner
 9     */
10    repositoryOwner: string
11  
12    /**
13     * The repository name
14     */
15    repositoryName: string
16  
17    /**
18     * The ref to fetch
19     */
20    ref: string
21  
22    /**
23     * The commit to checkout
24     */
25    commit: string
26  
27    /**
28     * Indicates whether to clean the repository
29     */
30    clean: boolean
31  
32    /**
33     * The depth when fetching
34     */
35    fetchDepth: number
36  
37    /**
38     * Indicates whether to fetch LFS objects
39     */
40    lfs: boolean
41  
42    /**
43     * Indicates whether to checkout submodules
44     */
45    submodules: boolean
46  
47    /**
48     * Indicates whether to recursively checkout submodules
49     */
50    nestedSubmodules: boolean
51  
52    /**
53     * The auth token to use when fetching the repository
54     */
55    authToken: string
56  
57    /**
58     * The SSH key to configure
59     */
60    sshKey: string
61  
62    /**
63     * Additional SSH known hosts
64     */
65    sshKnownHosts: string
66  
67    /**
68     * Indicates whether the server must be a known host
69     */
70    sshStrict: boolean
71  
72    /**
73     * Indicates whether to persist the credentials on disk to enable scripting authenticated git commands
74     */
75    persistCredentials: boolean
76  }