通过编程打印git版本并检查未提交的更改

Question

为了确保我的科学分析具有可重复性，我希望可以通过编程检查代码库中是否有未提交的修改，并在没有时输出所使用的提交版本。例如，如果存在未提交的更改，则应输出：

Warning: uncommitted changes made. This output may not be reproducible.

否则，生成。

Current commit: d27ec73cf2f1df89cbccd41494f579e066bad6fe

理想情况下，应该使用“管道”，而不是“瓷器”。

- Andrew Grimm

Answer 1

你需要的 Git 基础命令是diff-index、rev-parse --verify，以及可能还需要rev-parse --show-cdup和ls-files --others等命令。

以下 shell 程序使用这些 Git 命令，具有可调节的未跟踪/忽略处理功能，并且非常注意所有可能的错误情况。

#!/bin/sh

# warn-unclean: print a warning if the working tree and index are not clean

#  For utmost strictness, set check_untracked=yes and check_ignored=yes.
#  When both are 'yes', verify that working tree and index are identical to HEAD.
#  When only check_untracked is yes, extra ignored files are allowed.
#  When neither is yes, extra untracked files and ignored files are allowed.

check_untracked=yes
check_ignored=yes

warn() {
    echo 'Warning: '"$*" \
        'This output may not be reproducible.'
}

# Compare HEAD to index and/or working tree versions of tracked files
git diff-index --quiet HEAD
case $? in
    0)
        if test "$check_untracked" != yes; then
            clean=yes
        else
            # Still need to check for untracked files

            or_ignored=''
            exclude=--exclude-standard
            if test "$check_ignored" = yes; then
                or_ignored=' or ignored'
                exclude=''
            fi

            (
                # Move to top level of working tree
                if up="$(git rev-parse --show-cdup)"; then
                    test -n "$up" && cd "$up"
                else
                    echo 'error running "git rev-parse --show-cdup"'
                    exit 129
                fi

                # Check for untracked files
                git ls-files --others $exclude --error-unmatch . >/dev/null 2>&1
                case $? in
                    0)  # some untracked/ignored file is present
                        warn 'some untracked'"$or_ignored"' file is present.'
                        exit 1
                    ;;
                    1)  # no untracked files
                        exit 0
                    ;;
                    *)
                        echo 'error running "git diff-index"!'
                        exit 129
                    ;;
                esac

            )
            case $? in
                0) clean=yes ;;
                1) clean=no ;;
                *) exit $? ;;
            esac
        fi

        test "$clean" = yes &&
        if c="$(git rev-parse --verify HEAD)"; then
            echo 'Current commit: '"$c"
        else
            echo 'error running "git rev-parse --verify"!'
        fi
    ;;
    1)
        warn 'some tracked file has an uncommitted change.'
    ;;
    *)
        echo 'error running "git diff-index"!'
        exit 129
    ;;
esac

如果您想让退出代码在所有情况下都有意义，可以添加更多的exit。

如果您不关心所有错误处理或未跟踪/忽略处理，则可以使用简短的方法：

if git diff-index --quiet; then
    printf 'Current commit: %s\n' "$(git rev-parse --verify HEAD)
else
    echo 'Warning: …'
fi

你还可以以简洁的方式检查未跟踪的文件（这些文件可能已被忽略等），无需进行错误处理：

git ls-files --others --exclude-standard --error-unmatch \
    "./$(git rev-parse --show-cdup)" >/dev/null 2>&1

- Chris Johnsen

Answer 2

这里使用了porcelain，但是git diff --exit-code会在现有文件存在差异时退出并返回1，在现有文件没有差异时返回0。不幸的是，它不会检查未跟踪的文件。

这个答案中介绍了如何在Git中检索当前提交的哈希值，建议使用git rev-parse --verify HEAD来打印当前提交。

- Andrew Grimm