feat: add git lfs admin option

docs/usage/configuration-options.md

@@ -712,6 +712,18 @@ Under the hood, it creates a MR-level approval rule where `approvals_required` i
 This option works only when `automerge=true`, `automergeType=pr` and `gitLabAutomerge=true`.
 Also, approval rules overriding should not be [prevented in GitLab settings](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/settings.html#prevent-overrides-of-default-approvals).
 
+## gitLfsExclude
+
+See also the `allowGitLfs` and `gitNoVerify` options.
+
+**Note** This is not supported in the WhiteSource Renovate Hosted App.
+
+## gitLfsInclude
+
+See also the `allowGitLfs` and `gitNoVerify` options.
+
+**Note** This is not supported in the WhiteSource Renovate Hosted App.
+
 ## golang
 
 Configuration added here applies for all Go-related updates, however currently the only supported package manager for Go is the native Go Modules (the `gomod` manager).

docs/usage/self-hosted-configuration.md

@@ -11,6 +11,13 @@ Please also see [Self-Hosted Experimental Options](./self-hosted-experimental.md
 
 ## allowCustomCrateRegistries
 
+## allowGitLfs
+
+**Note** You need to also set the Git commands that Renovate passes to the `gitNoVerify` option.
+This way Renovate can commit and push Git LFS objects.
+
+**Note** `allowGitLfs` does not work in the official Renovate docker images, see issue [containerbase/buildpack#13](https://github.com/containerbase/buildpack/issues/13) for more information.
+
 ## allowPostUpgradeCommandTemplating
 
 Set to true to allow templating of dependency level post-upgrade commands.

lib/config/admin.ts

@@ -5,6 +5,7 @@ let adminConfig: RepoAdminConfig = {};
 // TODO: once admin config work is complete, add a test to make sure this list includes all options with admin=true (#9603)
 const repoAdminOptions = [
   'allowCustomCrateRegistries',
+  'allowGitLfs',
   'allowPostUpgradeCommandTemplating',
   'allowScripts',
   'allowedPostUpgradeCommands',

lib/config/definitions.ts

@@ -7,6 +7,13 @@ import * as pep440Versioning from '../versioning/pep440';
 import type { RenovateOptions } from './types';
 
 const options: RenovateOptions[] = [
+  {
+    name: 'allowGitLfs',
+    description: 'If false disallow git-lfs to pull files.',
+    type: 'boolean',
+    default: true,
+    admin: true,
+  },
   {
     name: 'allowPostUpgradeCommandTemplating',
     description: 'If true allow templating for post-upgrade commands.',
@@ -2037,6 +2044,19 @@ const options: RenovateOptions[] = [
     type: 'boolean',
     default: true,
   },
+  {
+    name: 'gitLfsInclude',
+    description: 'Which files should be included in git-lfs checkout',
+    stage: 'repository',
+    type: 'string',
+    default: '.yarn,yarn.lock,**/package-lock.json',
+  },
+  {
+    name: 'gitLfsExclude',
+    description: 'Which files should be excluded in git-lfs checkout',
+    stage: 'repository',
+    type: 'string',
+  },
 ];
 
 export function getOptions(): RenovateOptions[] {

lib/config/types.ts

@@ -88,6 +88,7 @@ export interface GlobalOnlyConfig {
 // The below should contain config options where admin=true
 export interface RepoAdminConfig {
   allowCustomCrateRegistries?: boolean;
+  allowGitLfs?: boolean;
   allowPostUpgradeCommandTemplating?: boolean;
   allowScripts?: boolean;
   allowedPostUpgradeCommands?: string[];
@@ -167,6 +168,9 @@ export interface RenovateConfig
 
   gitAuthor?: string;
 
+  gitLfsInclude?: string;
+  gitLfsExclude?: string;
+
   hostRules?: HostRule[];
 
   ignorePresets?: string[];

lib/util/git/index.ts

@@ -1,4 +1,5 @@
 import URL from 'url';
+import is from '@sindresorhus/is';
 import fs from 'fs-extra';
 import Git, {
   DiffResult as DiffResult_,
@@ -56,6 +57,10 @@ interface LocalConfig extends StorageConfig {
   branchCommits: Record<string, CommitSha>;
   branchIsModified: Record<string, boolean>;
   branchPrefix: string;
+
+  gitLfsInclude?: string;
+  gitLfsExclude?: string;
+
   ignoredAuthors: string[];
 }
 
@@ -185,6 +190,8 @@ export async function initRepo(args: StorageConfig): Promise<void> {
   config.ignoredAuthors = [];
   config.additionalBranches = [];
   config.branchIsModified = {};
+  config.gitLfsInclude = undefined;
+  config.gitLfsExclude = undefined;
   const { localDir } = getAdminConfig();
   git = Git(localDir);
   gitInitialized = false;
@@ -237,9 +244,13 @@ async function setBranchPrefix(branchPrefix: string): Promise<void> {
 export async function setUserRepoConfig({
   branchPrefix,
   gitIgnoredAuthors,
+  gitLfsInclude,
+  gitLfsExclude,
 }: RenovateConfig): Promise<void> {
   await setBranchPrefix(branchPrefix);
   config.ignoredAuthors = gitIgnoredAuthors ?? [];
+  config.gitLfsInclude = gitLfsInclude;
+  config.gitLfsExclude = gitLfsExclude;
 }
 
 export async function getSubmodules(): Promise<string[]> {
@@ -267,7 +278,7 @@ export async function syncGit(): Promise<void> {
     return;
   }
   gitInitialized = true;
-  const { localDir } = getAdminConfig();
+  const { localDir, allowGitLfs } = getAdminConfig();
   logger.debug('Initializing git repository into ' + localDir);
   const gitHead = join(localDir, '.git/HEAD');
   let clone = true;
@@ -305,6 +316,19 @@ export async function syncGit(): Promise<void> {
           opts.push(e[0], `${e[1]}`)
         );
       }
+
+      // istanbul ignore if
+      if (allowGitLfs) {
+        if (is.nonEmptyString(config.gitLfsInclude)) {
+          opts.push('-c', `lfs.fetchinclude=${config.gitLfsInclude}`);
+        }
+        if (is.nonEmptyString(config.gitLfsExclude)) {
+          opts.push('-c', `lfs.fetchexclude=${config.gitLfsExclude}`);
+        }
+      } else {
+        opts.push('-c', 'lfs.fetchexclude=*');
+      }
+
       await git.clone(config.url, '.', opts);
     } catch (err) /* istanbul ignore next */ {
       logger.debug({ err }, 'git clone error');