checkout/src/git-source-settings.ts

102 lines
1.8 KiB
TypeScript
Raw Normal View History

export interface IGitSourceSettings {
2020-03-27 13:12:15 -04:00
/**
* The location on disk where the repository will be placed
*/
repositoryPath: string
2020-03-27 13:12:15 -04:00
/**
* The repository owner
*/
repositoryOwner: string
2020-03-27 13:12:15 -04:00
/**
* The repository name
*/
repositoryName: string
2020-03-27 13:12:15 -04:00
/**
* The ref to fetch
*/
ref: string
2020-03-27 13:12:15 -04:00
/**
* The commit to checkout
*/
commit: string
2020-03-27 13:12:15 -04:00
/**
* Indicates whether to clean the repository
*/
clean: boolean
2020-03-27 13:12:15 -04:00
Add support for sparse checkouts (#1369) * Add support for sparse checkouts * sparse-checkout: optionally turn off cone mode While it _is_ true that cone mode is the default nowadays (mainly for performance reasons: code mode is much faster than non-cone mode), there _are_ legitimate use cases where non-cone mode is really useful. Let's add a flag to optionally disable cone mode. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> * Verify minimum Git version for sparse checkout The `git sparse-checkout` command is available only since Git version v2.25.0. The `actions/checkout` Action actually supports older Git versions than that; As of time of writing, the minimum version is v2.18.0. Instead of raising this minimum version even for users who do not require a sparse checkout, only check for this minimum version specifically when a sparse checkout was asked for. Suggested-by: Tingluo Huang <tingluohuang@github.com> Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> * Support sparse checkout/LFS better Instead of fetching all the LFS objects present in the current revision in a sparse checkout, whether they are needed inside the sparse cone or not, let's instead only pull the ones that are actually needed. To do that, let's avoid running that preemptive `git lfs fetch` call in case of a sparse checkout. An alternative that was considered during the development of this patch (and ultimately rejected) was to use `git lfs pull --include <path>...`, but it turned out to be too inflexible because it requires exact paths, not the patterns that are available via the sparse checkout definition, and that risks running into command-line length limitations. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> --------- Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Co-authored-by: Daniel <daniel.fernandez@feverup.com>
2023-06-09 09:08:21 -04:00
/**
* The array of folders to make the sparse checkout
*/
sparseCheckout: string[]
/**
* Indicates whether to use cone mode in the sparse checkout (if any)
*/
sparseCheckoutConeMode: boolean
2020-03-27 13:12:15 -04:00
/**
* The depth when fetching
*/
fetchDepth: number
2020-03-27 13:12:15 -04:00
/**
* Indicates whether to fetch LFS objects
*/
lfs: boolean
2020-03-27 13:12:15 -04:00
/**
* Indicates whether to checkout submodules
*/
2020-03-05 14:21:59 -05:00
submodules: boolean
2020-03-27 13:12:15 -04:00
/**
* Indicates whether to recursively checkout submodules
*/
2020-03-05 14:21:59 -05:00
nestedSubmodules: boolean
2020-03-27 13:12:15 -04:00
/**
* The auth token to use when fetching the repository
*/
authToken: string
2020-03-27 13:12:15 -04:00
/**
* The SSH key to configure
*/
2020-03-11 15:55:17 -04:00
sshKey: string
2020-03-27 13:12:15 -04:00
/**
* Additional SSH known hosts
*/
2020-03-11 15:55:17 -04:00
sshKnownHosts: string
2020-03-27 13:12:15 -04:00
/**
* Indicates whether the server must be a known host
*/
2020-03-11 15:55:17 -04:00
sshStrict: boolean
2020-03-27 13:12:15 -04:00
/**
* Indicates whether to persist the credentials on disk to enable scripting authenticated git commands
*/
persistCredentials: boolean
2021-11-01 12:43:18 -04:00
/**
* Organization ID for the currently running workflow (used for auth settings)
*/
workflowOrganizationId: number | undefined
/**
* Indicates whether to add repositoryPath as safe.directory in git global config
*/
setSafeDirectory: boolean
/**
* User override on the GitHub Server/Host URL that hosts the repository to be cloned
*/
githubServerUrl: string | undefined
}