git-source-settings.ts 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. export interface IGitSourceSettings {
  2. /**
  3. * The location on disk where the repository will be placed
  4. */
  5. repositoryPath: string
  6. /**
  7. * The repository owner
  8. */
  9. repositoryOwner: string
  10. /**
  11. * The repository name
  12. */
  13. repositoryName: string
  14. /**
  15. * The ref to fetch
  16. */
  17. ref: string
  18. /**
  19. * The commit to checkout
  20. */
  21. commit: string
  22. /**
  23. * Indicates whether to clean the repository
  24. */
  25. clean: boolean
  26. /**
  27. * The filter determining which objects to include
  28. */
  29. filter: string | undefined
  30. /**
  31. * The array of folders to make the sparse checkout
  32. */
  33. sparseCheckout: string[]
  34. /**
  35. * Indicates whether to use cone mode in the sparse checkout (if any)
  36. */
  37. sparseCheckoutConeMode: boolean
  38. /**
  39. * The depth when fetching
  40. */
  41. fetchDepth: number
  42. /**
  43. * Fetch tags, even if fetchDepth > 0 (default: false)
  44. */
  45. fetchTags: boolean
  46. /**
  47. * Indicates whether to use the --progress option when fetching
  48. */
  49. showProgress: boolean
  50. /**
  51. * Indicates whether to fetch LFS objects
  52. */
  53. lfs: boolean
  54. /**
  55. * Indicates whether to checkout submodules
  56. */
  57. submodules: boolean
  58. /**
  59. * Indicates whether to recursively checkout submodules
  60. */
  61. nestedSubmodules: boolean
  62. /**
  63. * The auth token to use when fetching the repository
  64. */
  65. authToken: string
  66. /**
  67. * The SSH key to configure
  68. */
  69. sshKey: string
  70. /**
  71. * Additional SSH known hosts
  72. */
  73. sshKnownHosts: string
  74. /**
  75. * Indicates whether the server must be a known host
  76. */
  77. sshStrict: boolean
  78. /**
  79. * The SSH user to login as
  80. */
  81. sshUser: string
  82. /**
  83. * Indicates whether to persist the credentials on disk to enable scripting authenticated git commands
  84. */
  85. persistCredentials: boolean
  86. /**
  87. * Organization ID for the currently running workflow (used for auth settings)
  88. */
  89. workflowOrganizationId: number | undefined
  90. /**
  91. * Indicates whether to add repositoryPath as safe.directory in git global config
  92. */
  93. setSafeDirectory: boolean
  94. /**
  95. * User override on the GitHub Server/Host URL that hosts the repository to be cloned
  96. */
  97. githubServerUrl: string | undefined
  98. }