如何在提交时限制文件大小？

Question

提交时是否有限制文件大小的选项？

例如：文件大小超过 500K 会产生警告。超过 10M 的文件大小将停止提交。

我完全知道 this question 这在技术上使它重复但答案只提供了一个解决方案 on push，这将是对我的要求来说太迟了。

Answer 1

有一个通用的预提交挂钩。您可以编写脚本来检查文件大小，然后接受或拒绝提交。 Git 但是让用户能够绕过检查）从命令行类型 "git help hooks" 获取更多信息。这是pre-commit hook的相关信息。

预提交

此挂钩由 git commit 调用，可以使用 --no-verify 选项绕过。它不带任何参数，并在获取建议的提交日志消息并进行提交之前调用。从此脚本以非零状态退出会导致 git 提交中止。

Answer 2

您需要实施 eis script you already look for in the pre-commit hook。

从文档中，我们了解到 预提交挂钩

takes no parameters, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with a non-zero status from this script causes the git commit command to abort before creating a commit.

基本上，调用挂钩是为了检查是否允许用户提交他的更改。

原来eis on other post做的脚本变成了

#!/bin/bash
# File size limit is meant to be configured through 'hooks.filesizelimit' setting
filesizelimit=$(git config hooks.filesizelimit)

# If we haven't configured a file size limit, use default value of about 10M
if [ -z "$filesizelimit" ]; then
        filesizelimit=10000000
fi

# You specify a warning limit
filesizewarning=500000

# With this command, we can find information about the file coming in that has biggest size
# We also normalize the line for excess whitespace
biggest_checkin_normalized=$(git ls-tree --full-tree -r -l HEAD | sort -k 4 -n -r | head -1 | sed 's/^ *//;s/ *$//;s/\s\{1,\}/ /g' )

# Based on that, we can find what we are interested about
filesize=`echo $biggest_checkin_normalized | cut -d ' ' -f4,4`

# Actual comparison
# To cancel a push, we exit with status code 1
# It is also a good idea to print out some info about the cause of rejection
if [ $filesize -gt $filesizelimit ]; then

        # To be more user-friendly, we also look up the name of the offending file
        filename=`echo $biggest_checkin_normalized | cut -d ' ' -f5,5`

        echo "Error: Too large push attempted." >&2
        echo  >&2
        echo "File size limit is $filesizelimit, and you tried to push file named $filename of size $filesize." >&2
        echo "Contact configuration team if you really need to do this." >&2
        exit 1
elif [ $filesize -gt $filesizewarning ]; then
        echo "WARNING ! A file size is bigger that $filesizewarning"
fi
exit 0

Answer 3

此预提交挂钩将执行文件大小检查：

.git/hooks/pre-commit

#!/bin/sh
hard_limit=$(git config hooks.filesizehardlimit)
soft_limit=$(git config hooks.filesizesoftlimit)
: ${hard_limit:=10000000}
: ${soft_limit:=500000}

list_new_or_modified_files()
{
    git diff --staged --name-status|sed -e '/^D/ d; /^D/! s/.\s\+//'
}

unmunge()
{
    local result="${1#\"}"
    result="${result%\"}"
    env echo -e "$result"
}

check_file_size()
{
    n=0
    while read -r munged_filename
    do
        f="$(unmunge "$munged_filename")"
        h=$(git ls-files -s "$f"|cut -d' ' -f 2)
        s=$(git cat-file -s "$h")
        if [ "$s" -gt $hard_limit ]
        then
            env echo -E 1>&2 "ERROR: hard size limit ($hard_limit) exceeded: $munged_filename ($s)"
            n=$((n+1))
        elif [ "$s" -gt $soft_limit ]
        then
            env echo -E 1>&2 "WARNING: soft size limit ($soft_limit) exceeded: $munged_filename ($s)"
        fi
    done

    [ $n -eq 0 ]
}

list_new_or_modified_files | check_file_size

以上脚本必须另存为 .git/hooks/pre-commit 并启用执行权限 (chmod +x .git/hooks/pre-commit)。

默认的软（警告）和硬（错误）大小限制设置为 500,000 和 10,000,000 字节，但可以分别通过 hooks.filesizesoftlimit 和 hooks.filesizehardlimit 设置进行覆盖：

$ git config hooks.filesizesoftlimit 100000
$ git config hooks.filesizehardlimit 4000000

Answer 4

@Leon 脚本的一个较短的、bash 特定版本，它以人类可读的格式打印文件大小。 --diff-filter=d 选项需要更新的 git：

#!/bin/bash
hard_limit=$(git config hooks.filesizehardlimit)
soft_limit=$(git config hooks.filesizesoftlimit)
: ${hard_limit:=10000000}
: ${soft_limit:=1000000}

status=0

bytesToHuman() {
  b=${1:-0}; d=''; s=0; S=({,K,M,G,T,P,E,Z,Y}B)
  while ((b > 1000)); do
    d="$(printf ".%01d" $((b % 1000 * 10 / 1000)))"
    b=$((b / 1000))
    let s++
  done
  echo "$b$d${S[$s]}"
}

# Iterate over the zero-delimited list of staged files.
while IFS= read -r -d '' file ; do
  hash=$(git ls-files -s "$file" | cut -d ' ' -f 2)
  size=$(git cat-file -s "$hash")

  if (( $size > $hard_limit )); then
    echo "Error: Cannot commit '$file' because it is $(bytesToHuman $size), which exceeds the hard size limit of $(bytesToHuman $hard_limit)."
    status=1
  elif (( $size > $soft_limit )); then
    echo "Warning: '$file' is $(bytesToHuman $size), which exceeds the soft size limit of $(bytesToHuman $soft_limit). Please double check that you intended to commit this file."
  fi
done < <(git diff -z --staged --name-only --diff-filter=d)
exit $status

与其他答案一样，这必须以执行权限保存为 .git/hooks/pre-commit。

示例输出：

Error: Cannot commit 'foo' because it is 117.9MB, which exceeds the hard size limit of 10.0MB.

Answer 5

只是想评论@Leon 提供的解决方案很棒。如果一个空目录开始尝试被跟踪，我遇到了一个小问题，它中止了。所以我不得不添加

[ -d "$f" ] && continue

在ls-files命令之前有以避免错误。

我更希望 post 发表评论，因为这不是答案，但我没有声望点数。

注意：我知道 git 'ignores' 个目录，但显然在预提交挂钩运行.

之前不知道

如何在提交时限制文件大小？

How to limit file size on commit?

linux

git

github

filesize