commit.ts

import is from '@sindresorhus/is';
import minimatch from 'minimatch';
import { FileData, platform } from '../../platform';
import { logger } from '../../logger';
import { RenovateConfig } from '../../config';

export type CommitConfig = RenovateConfig & {
  baseBranch?: string;
  branchName: string;
  commitMessage: string;
  excludeCommitPaths?: string[];
  updatedPackageFiles: FileData[];
  updatedArtifacts: FileData[];
};

export async function commitFilesToBranch(
  config: CommitConfig
): Promise<boolean> {
  let updatedFiles = config.updatedPackageFiles.concat(config.updatedArtifacts);
  // istanbul ignore if
  if (is.nonEmptyArray(config.excludeCommitPaths)) {
    updatedFiles = updatedFiles.filter(f => {
      const filename = f.name === '|delete|' ? f.contents : f.name;
      const matchesExcludePaths = config.excludeCommitPaths.some(path =>
        minimatch(filename, path, { dot: true })
      );
      if (matchesExcludePaths) {
        logger.debug(`Excluding ${filename} from commit`);
        return false;
      }
      return true;
    });
  }
  if (is.nonEmptyArray(updatedFiles)) {
    logger.debug(`${updatedFiles.length} file(s) to commit`);

    // istanbul ignore if
    if (config.dryRun) {
      logger.info('DRY-RUN: Would commit files to branch ' + config.branchName);
    } else {
      // API will know whether to create new branch or not
      await platform.commitFilesToBranch({
        branchName: config.branchName,
        files: updatedFiles,
        message: config.commitMessage,
        parentBranch: config.baseBranch || undefined,
      });
      logger.info({ branch: config.branchName }, `files committed`);
    }
  } else {
    logger.debug(`No files to commit`);
    return false;
  }
  return true;
}